The EXTFNAPIV4_DESCRIBE_PARM_NAME attribute indicates the parameter name. Used in a describe_parameter_get scenario.
Description
The name of a parameter to a UDF.
Usage
Gets the parameter name as defined in the CREATE PROCEDURE statement. Invalid for parameter 0.
Returns
On success, returns the length of the parameter name.
On failure, returns one of the generic
describe_parameter errors or:
- EXTFNAPIV4_DESCRIBE_BUFFER_SIZE_MISMATCH – get error returned if the describe_buffer is not large enough to hold the name.
- EXTFNAPIV4_DESCRIBE_INVALID_STATE – get error returned if the
query processing phase is not greater than Initial.
- EXTFNAPIV4_DESCRIBE_INVALID_PARAMETER – get error returned if the parameter is the result table.
Query Processing Phases
Valid in:
- Annotation phase
- Query optimization phase
- Plan building phase
- Execution phase