9.4.4 イベント情報通知構造体（OA_JG_EVENT

［機能］: イベント情報を通知します。

［記述形式］

記述形式を示します。

typedef struct_OA_JG_EVENT_1 {
      DWORD      dwStartSignature;      // シグネチャ
      DWORD      dwLevel;               // 構造体通知レベル
      DWORD      dwEvents;              // 発生したイベント
      LPSTR      lptPrinter;            // プリンタ名
      DWORD      dwPrinterStatus;       // プリンタで発生したエラー
      DWORD      dwPagesPrinted;        // 出力完了ページ数
      DWORD      dwTotalPages;          // 総ページ数
      DWORD      dwExtKind;             // ドキュメント識別子
      LPVOID     pNextAddr;             // 次のイベント情報通知構造体へのアドレス
}
OA_JG_EVENT_1, *POA_JG_EVENT_1;

［説明］

dwStartSignature: OAASYNC_EVENT_STARTSIGNATUREが設定されます。

dwLevel: 1が設定されます。

dwEvents

発生したイベントが設定されます。

待ち合わせモードによって取得できるイベントの詳細については、以下を参照してください。

⇒“表9.1 待ち合わせモードにOAJG_MODE1を指定した場合に取得できるイベント”

⇒“表9.2 待ち合わせモードにOAJG_MODE2を指定した場合に取得できるイベント”

lptPrinter: イベントが発生したプリンタ名が設定されます。

dwPrinterStatus

プリンタでエラーが発生した際（dwEventsにOA_JG_EVENT_ERRORが設定された際）にステータスが設定されます。プリンタで発生したエラーの詳細については、以下を参照してください。

⇒“表9.3 プリンタで発生したエラーの詳細”

dwPagesPrinted: 帳票の出力処理でエラーが発生したときと、帳票の出力処理が完了したときに、出力完了ページ数が設定されます。

dwTotalPages: 総ページ数が設定されます。スプールデータ形式にRAW形式を指定している場合には、常に0が設定されます。

dwExtKind: イベントに対応する帳票の出力要求のドキュメント識別子が通知されます。

pNextAddr

複数のイベントが発生している場合、リストでイベント情報通知構造体が通知されます。

次のイベント情報通知構造体が存在する場合は、そのアドレスが設定されます。

次のイベント情報通知構造体が存在しない場合、NULLが設定されます。

［備考］

OaJgAsyncWaitEvent関数によってイベント情報通知構造体を取得した場合、関数内部でメモリが獲得されます。不要になったときに、OaJgAsyncFreeEvent関数を呼び出して解放してください。
OaJgAsyncWaitEvent関数については、以下を参照してください。
⇒“9.4.1 OaJgAsyncWaitEvent関数”
OaJgAsyncFreeEvent関数については、以下を参照してください。
⇒“9.4.2 OaJgAsyncFreeEvent関数”
イベント情報通知構造体を取得した場合は、必ず最後まで（pNextAddrの値がNULLになるまで）、イベント情報通知構造体を参照して、必要な処理を行ってください。
待ち合わせモードによって取得できるイベントの詳細を示します。

表9.1 待ち合わせモードにOAJG_MODE1を指定した場合に取得できるイベント
イベント	分類	意味
OA_JG_EVENT_PRINTOUT	状態	帳票の出力処理が完了しました。
OA_JG_EVENT_DELETE	状態	帳票の出力要求が削除されました。
OA_JG_EVENT_PAUSE	状態	帳票の出力要求が保留されました。
OA_JG_EVENT_PAUSE_AWAKE	状態	帳票の出力要求の保留が解除されました。
OA_JG_EVENT_ERROR	エラー	帳票の出力処理でエラーが発生しました。
OA_JG_EVENT_ERROR_AWAKE	エラー	帳票の出力処理で発生したエラーが解除されました。

表9.2 待ち合わせモードにOAJG_MODE2を指定した場合に取得できるイベント
イベント	分類	意味
OAJG_MODE1のイベント	OAJG_MODE1のイベントと同じです。
OA_JG_EVENT_MESSAGE	応答メッセージ	ユーザに対処を求めるメッセージの応答を待ち合わせています。
OA_JG_EVENT_MESSAGE_AWAKE	応答メッセージ	ユーザに対処を求めるメッセージに応答されました。

帳票の出力処理でエラーが発生した場合に通知される、プリンタで発生したエラーの詳細を示します。

表9.3 プリンタで発生したエラーの詳細
エラー値	意味
OA_JG_ERROR_OFFLINE	出力装置がオフライン、またはストップ状態のため、帳票を出力することができません。
OA_JG_ERROR_PAPEROUT	出力装置が用紙切れのため、帳票を出力することができません。
OA_JG_ERROR_PRINTER	出力装置がエラー状態のため、帳票を出力することができません。
OA_JG_ERROR_FORWARD	リモート出力装置へ帳票データを転送中にエラーが発生しました。

9.4.4 イベント情報通知構造体（OA_JG_EVENT_1）