Purpose
Set Error Message is the service function that assigns an error message to the operator.
Structure
#include <pxoper.h> PXSTC_Code PX_SetErrorMessage(PX_OperatorHandle operator, PX_ErrorText message, PX_Length messageLength);
where the following is true:
| Parameter | Function | Specification |
|---|---|---|
| message | input | Location of the error message text. |
| messageLength | input | Length of the error message text. |
| operator | input | Operator handle to which the error message is assigned. |
Return Codes
The following Set Error Message 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 setting of the error message. |
Usage Notes
Consider the following when defining the Set Error Message function.
| Topic | Usage Notes |
|---|---|
| Status | If the function status is PXSTC_Success, then the following is true:
|