Purpose
Delete Global Variable is the service function that deletes a global variable that had been created for the operator.
Structure
#include <pxoper.h> PXSTC_Code PX_DeleteGlobalVar(PX_OperatorHandle operator, PX_Name varName);
where the following is true:
| Parameter | Function | Specification |
|---|---|---|
| operator | input | Instance of the operator handle for which the global variable is being deleted. |
| varName | input | Name of the global variable. |
Return Codes
The following Delete Global Variable 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 deletion of the global variable. |
Usage Notes
Consider the following when using the Delete Global Variable function.
| Topic | Usage Notes |
|---|---|
| Status | If the function status is PXSTC_Success, all items of the global variable were deleted successfully. See also the Create Global Variable function. |