6.24 GET_ERROR_INFO

適用対象

ExtractおよびReplicat

説明

GET_ERROR_INFOファンクションでは、破棄レコードに関連付けられているエラー情報を取得します。ユーザー・イグジットは、この情報をカスタム・エラー処理ロジックで使用できます。たとえば、ユーザー・イグジットは詳細なエラー情報を含む電子メール・メッセージを送信できます。

ユーザー・イグジットの文字セッションが、SET_SESSION_CHARSETを使用して、オペレーティング・システムのデフォルトのキャラクタ・セット以外の値に設定されている場合、ucharset.hファイルのULIB_CS_DEFAULTで定義されているように、ユーザー・イグジットとプロセス間で交換されるメッセージ・データは、セッションのキャラクタ・セットで解釈されます。

構文

#include "usrdecs.h"
short result_code;
error_info_def error_info;
ERCALLBACK (GET_ERROR_INFO, &error_info, &result_code);

バッファ

typedef struct
{
long error_num;
char *error_msg;
long max_length;
long actual_length;
short msg_truncated;
} error_info_def;

入力

error_msg

返されるエラー・メッセージを受け付けるバッファへのポインタ。

max_length

結果のエラー・メッセージを受け付けるために割り当てたerror_msgバッファの最大長。NULL終了文字列として返されます。

出力

error_num

破棄ファイルに関連付けられているSQLまたはシステム・エラー番号。

error_msg

破棄レコードに関連付けられているNULLで終了するエラー・メッセージ文字列へのポインタ。

actual_length

NULL終了文字を含まないエラー・メッセージ長。

msg_truncated

エラー・メッセージが切り捨てられたかどうかを示すフラグ(0または1)。切捨ては、エラー・メッセージとNULL終了文字を足した長さが、最大バッファ長を超えるときに行われます。

返される値

EXIT_FN_RET_INVALID_CONTEXT
EXIT_FN_RET_OK