EXTFNAPIV4_DESCRIBE_COL_WIDTH (Get)

The EXTFNAPIV4_DESCRIBE_COL_WIDTH attribute indicates the width of the column. Used in a describe_column_get scenario.

Data Type

a_sql_uint32

Description

The width of a column. Column width is the amount of storage, in bytes, required to store a value of the associated data type. This property is valid only for table arguments.

Usage

If a UDF gets this property, then returns the width of the column as defined in the CREATE PROCEDURE statement.

Returns

On success, returns the sizeof(a_sql_uint32).

On failure, returns one of the generic describe_column errors, or:
  • EXTFNAPIV4_DESCRIBE_BUFFER_SIZE_MISMATCH – get error returned if the describe buffer is not the size of a_sql_uint32.
  • EXTFNAPIV4_DESCRIBE_INVALID_STATE – get error returned if the query processing state is not greater than Initial.

Query Processing States

Parent topic: Attributes for *describe_column_get