EXTFNAPIV4_DESCRIBE_PARM_SCALE Attribute (Set)

The EXTFNAPIV4_DESCRIBE_PARM_SCALE attribute indicates the scale of a parameter. Used in a describe_parameter_set scenario.

Data Type

a_sql_uint32

The scale of a parameter to a UDF. For arithmetic data types, parameter scale is the number of digits to the right of the decimal point in a number.

This attribute is invalid for:

This is a read-only property. The scale is derived from the associated column data type. Once the data type is set, you cannot change the scale.

On success, returns sizeof(a_sql_uint32).

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 size of a_sql_uint32.
EXTFNAPIV4_DESCRIBE_INVALID_STATE – set error returned if the state is not Annotation.
EXTFNAPIV4_DESCRIBE_INVALID_PARAMETER – set error returned if the specified parameter is a table parameter. This includes parameter 0, or parameter n, where n is an input table.

Valid in: