Set Error Message - Parallel Transporter

Teradata Parallel Transporter Operator プログラマ ガイド

Product
Parallel Transporter
Release Number
16.20
Published
2018年4月
Language
日本語
Last Update
2018-09-07
dita:mapPath
ja-JP/zgu1512703446673.ditamap
dita:ditavalPath
ja-JP/zgu1512703446673.ditaval
dita:id
B035-2435
Product Category
Teradata Tools and Utilities

目的

Set Error Messageは、エラー メッセージをオペレータに割り当てるサービス関数です。

構造

#include <pxoper.h>
PXSTC_Code PX_SetErrorMessage(PX_OperatorHandle  operator,
   PX_ErrorText  message,
   PX_Length  messageLength);

次のような場合に当てはまります。

パラメータ 機能 指定
message 入力 エラー メッセージ テキストの位置
messageLength 入力 エラー メッセージ テキストの長さ
operator 入力 エラー メッセージの割当て先となるオペレータ ハンドル

戻りコード

以下のSet Error Message関数のステータス コードは、Teradata PTオペレータ インターフェースによって定義されます。

ステータス コード 意味
PXSTC_InvalidArgument 1つ以上の正しくない入力引数
PXSTC_BadHandle 未定義のオブジェクト ハンドル
PXSTC_Success エラー メッセージの設定の成功

使用上の注意

Set Error Message関数を定義する場合の注意事項は、以下を考慮してください。

対象 使用上の注意
ステータス 関数のステータスがPXSTC_Successの場合、以下がTrueになります。
  • メッセージパラメータによって指定された位置に格納されたエラー メッセージが、このオペレータによって保存されます。
  • メッセージ長は、messageLengthパラメータによって示されます。