16.10 - Free Storage - 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

Free Storage is the service function that frees the operator storage that was previously allocated.

Structure

#include <pxoper.h>
PXSTC_Code PX_FreeStorage(PX_OperatorHandle  operator, PX_Addr  storageAddr);

where the following is true:

Parameter Function Specification
operator input Operator handle for which the storage is to be freed.
storageAddr input Address of the storage to be freed.

Return Codes

The following Free Storage 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_Success Successful access to the object attribute.

Usage Notes

Consider the following when defining the Free Storage function.

Topic Usage Notes
Status If the function status is PXSTC_Success, the storage at the location indicated by the storageAddr pointer was successfully freed. See also Allocate Storage.