EXTFNAPIV4_DESCRIBE_PARM_NAME Attribute (Set)

The EXTFNAPIV4_DESCRIBE_PARM_NAME attribute indicates the parameter name. Used in a describe_parameter_set scenario.

Data Type

char[]

Description

The name of a parameter to a UDF.

Usage

If the UDF sets this property, the server compares the value with the name of the parameter supplied in the CREATE PROCEDURE statement. If the two values do not match, the server returns an error. This allows the UDF to ensure the CREATE PROCEDURE statement has the same parameter names as the UDF is expecting.

Returns

On success, returns the length of the parameter name.

On failure, returns one of the generic describe_parameter errors or:

EXTFNAPIV4_DESCRIBE_INVALID_STATE – set error returned if the state is not equal to Annotation.
EXTFNAPIV4_DESCRIBE_INVALID_PARAMETER – set error returned if the parameter is the result table.
EXTFNAPI4_DESCRIBE_INVALID_ATTRIBUTE_VALUE – set error returned if the UDF tries to reset the name.

Query Processing States

Valid in:

Annotation state