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
提供的參數。包含動詞程式碼，LUA_VERB_RUI要求單位介面 (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 為零時，才需要此參數。

如果名稱短于八個字元，則此參數長度為 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 參數設定為零。

lua_max_length
RUI_PURGE未使用，且應設定為零。

lua_data_length
RUI_PURGE未使用，且應設定為零。

lua_data_ptr
指向要取消之 RUI_READ 動詞 VCB 的位置。

lua_post_handle
提供的參數。如果事件要完成非同步通知，請在 Microsoft® Windows Server 下使用。此變數包含要發出訊號的事件控制碼或視窗控制碼。

lua_th
RUI_PURGE未使用，且應設定為零。

lua_rh
RUI_PURGE未使用，且應設定為零。

lua_flag1
RUI_PURGE未使用，且應設定為零。

lua_message_type
RUI_PURGE未使用，且應設定為零。

lua_flag2
傳回的參數。包含 LUA 所傳回之訊息的旗標。

lua_flag2.async

表示如果設為 1，則 LUA 介面動詞命令會以非同步方式完成。

lua_resv56
保留且應設定為零。

lua_encr_decr_option
保留且應設定為零。

傳回碼

LUA_OK
主要傳回碼;已成功執行動詞。

LUA_CANCELED
主要傳回碼;動詞未順利完成，因為它已由另一個動詞取消。

LUA_TERMINATED

次要傳回碼; RUI_TERMRUI_PURGE擱置時發出。

LUA_PARAMETER_CHECK
主要傳回碼;動詞未執行，因為發生參數錯誤。

LUA_BAD_DATA_PTR

次要傳回碼; lua_data_ptr 參數設定為 null。

LUA_BAD_SESSION_ID

次要傳回碼;lua_sid在 VCB 中指定了不正確值。

LUA_INVALID_POST_HANDLE

次要傳回碼;對於使用事件做為非同步張貼方法的 Windows 作業系統，Windows LUA VCB 不包含有效的事件控制碼。

LUA_RESERVED_FIELD_NOT_ZERO

次要傳回碼;動詞記錄中的保留字段或這個動詞未使用的參數設定為非零值。

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 遇到 ABEND。

LUA_SESSION_FAILURE
主要傳回碼;必要的主機整合伺服器元件已終止。

LUA_LU_COMPONENT_DISCONNECTED

次要傳回碼;表示 LUA 會話因為連結服務或主機 LU 發生問題而失敗。

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_READ可以無限期地等候。 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

語法

成員

傳回碼

備註

另請參閱

其他資源