Common error returns for describe_parameter get and set calls.
| Get | Set |
|---|---|
EXTFNAPIV4_DESCRIBE_INVALID_PARAMETER – get error returned if the cntxt or describe_buffer is NULL, or if describe_buffer_length is 0. |
EXTFNAPIV4_DESCRIBE_INVALID_PARAMETER – set error returned if the cntxt or describe_buffer is NULL, or if describe_buffer_length is 0. |
| EXTFNAPIV4_DESCRIBE_INVALID_PARAMETER – get error returned if the cntxt parameter is invalid. | EXTFNAPIV4_DESCRIBE_INVALID_PARAMETER – set error returned if the cntxt parameter is invalid. |
| EXTFNAPIV4_DESCRIBE_INVALID_PARAMETER – get error returned if the provided parameter number is outside the legal range for the procedure; that is, if the parameter number is < 0 or > the number of parameters for the procedure. | EXTFNAPIV4_DESCRIBE_INVALID_PARAMETER – set error returned if the provided parameter number is outside the legal range for the procedure; that is, if the parameter number is < 0 or > the number of parameters for the procedure. |
| EXTFNAPIV4_DESCRIBE_ UNKNOWN_ATTRIBUTE – get error returned if the value of describe_type is an invalid a_v4_extfn_describe_parm_type describe type. | EXTFNAPIV4_DESCRIBE_ UNKNOWN_ATTRIBUTE – set error returned if the value of describe_type is an invalid a_v4_extfn_describe_parm_type describe type. |
EXTFNAPIV4_DESCRIBE_BUFFER_SIZE_MISMATCH – get error returned if there is a discrepancy between the requested attribute size and the supplied describe_buffer_length. For fixed-size attributes, such as an a_sql_byte data type, the sizes must match. For variable-length attribute data types, such as char[], the supplied buffer needs to be at least large enough to hold the value of the requested attribute. |
EXTFNAPIV4_DESCRIBE_BUFFER_SIZE_MISMATCH – set error returned if there is a discrepancy between the size of the requested attribute and the supplied describe_buffer_length. For fixed-size attributes, such as an a_sql_byte data type, the sizes must match. |