Purpose
Get Column Schema List is the service function that retrieves the list of column handles associated with a table schema.
Structure
#include <pxoper.h> PXSTC_Code PX_GetColumnSchemaList( PX_TableSchemaHandle tableSchemaHandle, PX_ColumnSchemaList * columnSchemaList, PX_Count * columnSchemaCount);
where the following is true:
| Parameter | Function | Specification |
|---|---|---|
| columnSchemaCount | output | Number of column schemas in the list. |
| columnSchemaList | output | Pointer to the location of the retrieved column schema list. |
| tableSchemaHandle | input | Table schema handle from which the column schema list is to be retrieved. |
Return Codes
The following Get Column Schema List function status codes are defined by the Teradata PT operator interface:
| Status Code | Signifies |
|---|---|
| PXSTC_InvalidArgument | One or more bad input arguments. |
| PXSTC_BadHandle | An undefined data schema handle. |
| PXSTC_NotFound | The specified column schema list was not found in the specified object. |
| PXSTC_Success | Successful retrieval of the list of column handles. |
Usage Notes
Consider the following when defining the Get Column Schema List function.
| Topic | Usage Notes |
|---|---|
| Status | If the function status is PXSTC_Success, the address of the column schema list is stored in the location pointed to by the columnSchemaList parameter. See also Get Table Schema List. |