The EXTFNAPIV4_DESCRIBE_PARM_TABLE_NUM_COLUMNS attribute indicates the number of columns in the table. Used in a describe_parameter_get scenario.
Description
The number of columns in the table. Only valid for argument 0 and table arguments.
Usage
Returns the number of columns in the specified table argument. Argument 0 returns the number of columns in the result table.
Returns
On success, returns the sizeof(a_sql_uint32).
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 the size of size of a_sql_uint32.
- EXTFNAPIV4_DESCRIBE_INVALID_STATE – get error returned if the
query processing phase is not greater than Initial.
- EXTFNAPIV4_DESCRIBE_NON_TABLE_PARAMETER – get
error returned if the parameter is not a TABLE parameter.
Query Processing Phases
Valid in:
- Annotation phase
- Query Optimization phase
- Plan Building phase
- Execution phase