Initiate is the user-provided function that establishes the processing environment for an operator.
#include <pxoper.h> PXSTC_Code PX_Initiate(PX_OperatorHandle operator, PX_LogInt phase);
where the following is true:
|operator||input||Operator handle associated with the Initiate function.
The operator parameter is a handle that identifies the operator that the Initiate function is bound to. You can use this handle to invoke any of the Teradata PT service functions described in this chapter.
|phase||input||Current processing phase number|
The following Initiate function status codes are defined by the Teradata PT operator interface.
|PXSTC_EndMethod||Successful initialization of the operator.|
|PXSTC_NextPhase||Proceed with the next processing phase.|
|PXSTC_SamePhase||Continue with the current processing phase.|
Define additional Initiate function status codes as required to support your operator.
Consider the following when defining the Initiate function.
|Status||If the function status is PXSTC_EndMethod, the processing environment was successfully established by this function. See also the Terminate function.|