*describe_parameter_set

The describe_parameter_set v4 API method sets properties about a single parameter to the UDF.

Declaration

a_sql_int32 (SQL_CALLBACK *describe_parameter_set)(
            a_v4_extfn_proc_context     	    *cntxt,
            a_sql_uint32                	    arg_num,
            a_v4_extfn_describe_udf_type    	describe_type,
            const void                  	    *describe_buffer,
            size_t                      	    describe_buffer_len );

Parameters

Parameter Description
cntxt The procedure context object.
arg_num The ordinal of the table parameter (0 is for the result table and 1 is for first input argument)
describe_type A selector indicating what property to set.
describe_buffer A structure that holds the describe information for the specified property to set on the server. The specific structure or data type is indicated by the describe_type parameter.
describe_buffer_length The length in bytes of the describe_buffer.

Returns

On success, returns 0 or the number of bytes written to the describe_buffer. A value of 0 indicates that the server was unable to set the attribute, but no error condition occurred. If an error occurred, or no property was retrieved, this function returns one of the generic describe_parameter errors.