EXTFNAPIV4_DESCRIBE_PARM_TYPE Attribute (Set)

The EXTFNAPIV4_DESCRIBE_PARM_TYPE attribute indicates the data type of the parameter. Used in a describe_parameter_set scenario.

Data Type

a_sql_data_type

Description

The data type of a parameter to a UDF.

Usage

When the UDF sets this property, the server compares the value to the parameter type supplied in the CREATE PROCEDURE statement. If the two values do not match, the server returns an error. This check ensures that the CREATE PROCEDURE statement has the same parameter data types that the UDF expects.

Returns

On success, returns sizeof(a_sql_data_type).

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

EXTFNAPIV4_DESCRIBE_BUFFER_SIZE_MISMATCH – set error returned if the describe_buffer is not the sizeof(a_sql_data_type).
EXTFNAPIV4_DESCRIBE_INVALID_STATE – set error returned if the query processing state is not equal to Annotation.
EXTFNAPI4_DESCRIBE_INVALID_ATTRIBUTE_VALUE – set error returned if the UDF tries to set the datatype of a parameter to something other than what it is already defined as.

Query Processing States

Valid in:

Annotation state