EXTFNAPIV4_DESCRIBE_PARM_CAN_BE_NULL Attribute (Get)

The EXTFNAPIV4_DESCRIBE_PARM_CAN_BE_NULL attribute indicates whether or not the parameter is null. Used in a describe_parameter_get scenario.

Data Type

a_sql_byte

Description

True, if the value of a parameter can be NULL at the time of execution. For a table parameter or parameter 0, the value is false.

Usage

Gets whether or not the specified parameter can be null during query execution.

Returns

On success, returns the sizeof(a_sql_byte).

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 a_sql_byte.
  • EXTFNAPIV4_DESCRIBE_INVALID_STATE – Get error returned if the state is not greater than Plan Building.

Query Processing States

Valid in:
  • Execution state