RUI_PURGE

[アーティクル]
10/14/2023

RUI_PURGE動詞は、前のRUI_READを取り消します。

次の構造体は、 RUI_PURGE によって使用される動詞制御ブロック (VCB) の LUA_COMMON メンバーについて説明します。

構文

  
struct LUA_COMMON {  
    unsigned short lua_verb;  
    unsigned short lua_verb_length;  
    unsigned short lua_prim_rc;  
    unsigned long  lua_sec_rc;  
    unsigned short lua_opcode;  
    unsigned long  lua_correlator;  
    unsigned char  lua_luname[8];  
    unsigned short lua_extension_list_offset;  
    unsigned short lua_cobol_offset;  
    unsigned long  lua_sid;  
    unsigned short lua_max_length;  
    unsigned short lua_data_length;  
    char FAR *      lua_data_ptr;  
    unsigned long  lua_post_handle;  
    struct LUA_TH  lua_th;  
    struct LUA_RH  lua_rh;  
    struct LUA_FLAG1 lua_flag1;  
    unsigned char  lua_message_type;  
    struct LUA_FLAG2 lua_flag2;  
    unsigned char  lua_resv56[7];  
    unsigned char  lua_encr_decr_option;  
};

メンバー

lua_verb
指定されたパラメーター。要求ユニットインターフェイス (RUI) 動詞のLUA_VERB_RUI動詞コードが含まれています。

lua_verb_length
指定されたパラメーター。論理ユニットアプリケーション (LUA) VCB の長さをバイト単位で指定します。これには、発行される動詞レコードの長さが含まれている必要があります。

lua_prim_rc
動詞の完了時に LUA によって設定されたプライマリリターンコード。有効な戻りコードは、発行される LUA 動詞によって異なります。

lua_sec_rc
動詞の完了時に LUA によって設定されたセカンダリリターンコード。有効な戻りコードは、発行される LUA 動詞によって異なります。

lua_opcode
指定されたパラメーター。発行される動詞の LUA コマンドコード (動詞操作コード) が含LUA_OPCODE_RUI_PURGE。

lua_correlator
指定されたパラメーター。動詞を他のユーザー指定の情報とリンクするユーザー指定の値が含まれます。 LUA では、この情報は使用または変更されません。このパラメーターは省略可能です。

lua_luname
指定されたパラメーター。 Windows LUA セッションで使用されるローカル LU の ASCII 名を指定します。

RUI_PURGEは 、lua_sidが 0 の場合にのみ、このパラメーターを必要とします。

このパラメーターの長さは 8 バイトで、名前が 8 文字より短い場合は、右側にスペース (0x20) が埋め込まれます。

lua_extension_list_offset
Microsoft® Host Integration Server の RUI では使用されず、ゼロに設定する必要があります。

lua_cobol_offset
ホスト統合サーバーの LUA では使用されず、ゼロにする必要があります。

lua_sid
指定されたパラメーター。セッション識別子を指定し、 SLI_OPEN と RUI_INITによって返されます。他の動詞では、このパラメーターを使用して、コマンドに使用されるセッションを識別します。他の動詞で lua_luname パラメーターを使用してセッションを識別する場合は、 lua_sid パラメーターを 0 に設定します。

lua_max_length
RUI_PURGEでは使用されず、0 に設定する必要があります。

lua_data_length
RUI_PURGEでは使用されず、0 に設定する必要があります。

lua_data_ptr
取り消される RUI_READ 動詞 VCB の位置を指します。

lua_post_handle
指定されたパラメーター。イベントによって非同期通知を実行する場合は、Microsoft® Windows Server で使用されます。この変数には、通知されるイベントのハンドルまたはウィンドウハンドルが含まれます。

lua_th
RUI_PURGEでは使用されず、0 に設定する必要があります。

lua_rh
RUI_PURGEでは使用されず、0 に設定する必要があります。

lua_flag1
RUI_PURGEでは使用されず、0 に設定する必要があります。

lua_message_type
RUI_PURGEでは使用されず、0 に設定する必要があります。

lua_flag2
返されたパラメーター。 LUA によって返されるメッセージのフラグが含まれます。

lua_flag2.async

LUA インターフェイス動詞が 1 に設定されている場合に非同期的に完了したことを示します。

lua_resv56
予約済みで、0 に設定する必要があります。

lua_encr_decr_option
予約済みで、0 に設定する必要があります。

リターンコード

LUA_OK
プライマリリターンコード。動詞は正常に実行されました。

LUA_CANCELED
プライマリリターンコード。動詞は別の動詞によって取り消されたため、正常に完了しませんでした。

LUA_TERMINATED

セカンダリリターンコード。 RUI_PURGE が 保留中の間 にRUI_TERMが発行されました。

LUA_PARAMETER_CHECK
プライマリリターンコード。パラメーターエラーのため、動詞は実行されませんでした。

LUA_BAD_DATA_PTR

セカンダリリターンコード。 lua_data_ptr パラメーターが null に設定されました。

LUA_BAD_SESSION_ID

セカンダリリターンコード。VCB でlua_sid の無効な値が指定されました。

LUA_INVALID_POST_HANDLE

セカンダリリターンコード。非同期投稿方法としてイベントを使用する Windows オペレーティングシステムの場合、Windows LUA VCB には有効なイベントハンドルが含まれていません。

LUA_RESERVED_FIELD_NOT_ZERO

セカンダリリターンコード。動詞レコードの予約フィールド、またはこの動詞で使用されないパラメーターが 0 以外の値に設定されました。

LUA_VERB_LENGTH_INVALID

セカンダリリターンコード。LUA 動詞が LUA によって予期しない値 lua_verb_length 発行されました。

LUA_STATE_CHECK
プライマリリターンコード。動詞は無効な状態で発行されたため、実行されませんでした。

LUA_NO_RUI_SESSION

セカンダリリターンコード。 RUI_INIT 、この動詞で指定された LU 名に対してまだ正常に完了していません。

LUA_UNSUCCESSFUL
プライマリリターンコード。指定された動詞は有効でしたが、動詞が正常に完了しませんでした。

LUA_INVALID_PROCESS

セカンダリリターンコード。この動詞を発行した OS/2 プロセスは、このセッション に対してRUI_INIT を発行したのと同じプロセスではありません。セッションを開始したプロセスのみが、そのセッションで動詞を発行できます。

LUA_NO_READ_TO_PURGE

セカンダリリターンコード。 lua_data_ptr に RUI_READ VCB へのポインターが含まれていないか、 RUI_PURGE が発行される前 に完了RUI_READ 。

LUA_COMM_SUBSYSTEM_ABENDED
プライマリリターンコード。次のいずれかの条件を示します。

このメッセージ交換で使用されているノードで、ABEND が発生しました。
トランザクションプログラム (TP) と物理ユニット (PU) 2.1 ノード間の接続が切断されました (LAN エラー)。
TP コンピューターの SnaBase で、異常終了が発生しました。

LUA_SESSION_FAILURE
主なリターンコード。必要な Host Integration Server コンポーネントが終了しました。

LUA_LU_COMPONENT_DISCONNECTED

セカンダリリターンコード。は、リンクサービスまたはホスト LU に問題があるため、LUA セッションが失敗したことを示します。

LUA_RUI_LOGIC_ERROR

セカンダリリターンコード。LUA 内で内部エラーが検出されました。このエラーは、通常の操作中には発生しません。

LUA_INVALID_VERB
主なリターンコード。動詞コードまたは操作コード、またはその両方が無効です。動詞が実行されませんでした。

LUA_STACK_TOO_SMALL
プライマリリターンコード。アプリケーションのスタックサイズが小さすぎて動詞を実行できません。アプリケーションのスタックサイズを増やしてください。

LUA_COMM_SUBSYSTEM_NOT_LOADED
主なリターンコード。必要なコンポーネントを読み込めなかったか、動詞の処理中に終了しました。そのため、通信を行うことができませんでした。是正措置については、システム管理者に問い合わせてください。

LUA_UNEXPECTED_DOS_ERROR
主なリターンコード。オペレーティングシステム呼び出しを発行した後、予期しないオペレーティングシステムのリターンコードが受信され、セカンダリリターンコードで指定されます。

注釈

RUI_READ は、 lua_flag1.nowait (即時戻り) オプションを使用せずに送信され、指定されたフローで使用できるデータがない場合、無期限に待機できます。 RUI_PURGE は、待機中の動詞を強制的に返します (主なリターンコードLUA_CANCELED)。

この動詞は、 RUI_READ が発行され、完了が保留中の場合にのみ使用されます。 (主な戻りコードはLUA_IN_PROGRESSです)。

参照

RUI_INIT
RUI_READ
RUI_TERM
RUI_WRITE
SLI_OPEN
SLI_PURGE
SLI_RECEIVE
SLI_SEND

RUI_PURGE

構文

メンバー

リターン コード

注釈

参照

その他のリソース

リターンコード