Get Column Value - Parallel Transporter

Teradata® Parallel Transporter Operator Programmer Guide
Product
Parallel Transporter
Release Number
17.20
Published
June 2022
ft:locale
en-US
ft:lastEdition
2022-06-21
dita:mapPath
yvm1645201744157.ditamap
dita:ditavalPath
obe1474387269547.ditaval
dita:id
B035-2435
Product Category
Teradata Tools and Utilities

Purpose

Get Column Value is the service function that retrieves the data value associated with a column.

Structure

#include <pxoper.h>
PXSTC_Code PX_GetColumnValue(PX_ColumnHandle  columnHandle,
   PX_Indicator *  nullIndicator,
   PX_DataAddr *  dataAddr,
   PX_Length *  dataLength);

where the following is true:

Parameter Function Specification
columnHandle input Column handle from which the column value is to be retrieved.
dataAddr output Pointer to the address of the column value.
dataLength output Pointer to the length of the column value.
nullIndicator output Pointer to the indication of whether or not the column value is NULL.

Return Codes

The following Get Column Value 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 column handle.
PXSTC_Success Successful projection of data value to the column.

Usage Notes

Consider the following when defining the Get Column Value function.

Topic Usage Notes
Status If the function status is PXSTC_Success:
  • The nullIndicator parameter indicates whether or not the column value is NULL.
  • The dataAddr parameter stores the address of the column value.
  • The dataLength parameter stores the length of the returned column value.

See also the Put Column Value function.