The describe_udf_set v4 API method sets UDF properties on the server.
a_sql_int32 (SQL_CALLBACK *describe_udf_set)( a_v4_extfn_proc_context *cntxt, a_v4_extfn_describe_udf_type describe_type, const void *describe_buffer, size_t describe_buffer_len );
Parameter | Description |
---|---|
cntxt | The procedure context object for this UDF. |
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 describe_buffer. |
On success, returns the number of bytes written to the describe_buffer. If an error occurs, or no property is retrieved, this function returns one of the generic describe_udf errors.
If an error occurs, or no property is retrieved, this function returns one of the generic describe_udf errors, or:
EXTFNAPIV4_DESCRIBE_INVALID_PARAMETER – set error returned if any of the cntxt or describe_buffer arguments are NULL or if describe_buffer_length is 0.
EXTFNAPIV4_DESCRIBE_BUFFER_SIZE_MISMATCH – set error returned if there is a discrepancy between the requested attribute’s size and the supplied describe_buffer_length.