16.10 - Put Attribute - Parallel Transporter

Teradata Parallel Transporter Operator Programmer Guide

prodname
Parallel Transporter
vrm_release
16.10
created_date
May 2017
category
Programming Reference
featnum
B035-2435-057K

Purpose

Put Attribute is the service function that assigns a value to a specific operator attribute or to an accessible Teradata PT system attribute.

Structure

#include <pxoper.h>
PXSTC_Code PX_PutAttribute(PX_OperatorHandle  operator,
   PX_AttributeName  attributeName,
   PX_AttributeValue  attributeValue,
   PX_Length  valueLength);

where the following is true:

Parameter Function Specification
attributeName input Name of the operator attribute to be assigned the value.
attributeValue input Address of the location containing the value to be assigned to the operator attribute.
operator input Operator handle to which the attribute value is to be assigned.
valueLength input Length of the value to be assigned to the operator attribute.

Return Codes

The following Put Attribute 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 object handle.
PXSTC_NotFound The specified attribute was not found in the specified object.
PXSTC_Success Successful access to the specified attribute.

Usage Notes

Consider the following when defining the Put Attribute function.

Topic Usage Notes
System Attributes The following table lists the Teradata PT system attributes that you can set with the Put Attributes function. See also the Get Attribute function.
Status If the function status is PXSTC_Success, the value was successfully assigned to the operator attribute.
Put-Accessible System Attributes
Attribute Name Data Type Data Length (in bytes) Description
SYSTEM_Code PX_Code 4 System ABEND code
SYSTEM_UserAreaAddr PX_Addr 4 Address of the user area