RUI_PURGE

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 名稱。

如果lua_sid為零, RUI_PURGE只需要此參數。

此參數的長度為8個位元組,如果名稱少於8個字元,則會在右邊填補空格 (0x20) 。

lua_extension_list_offset
Microsoft® Host Integration Server 中的 RUI 未使用,而且應設為零。

lua_cobol_offset
Host Integration Server 中的 LUA 未使用,而且應該為零。

lua_sid
提供的參數。 指定會話識別碼,並由 SLI_OPENRUI_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_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

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

LUA_VERB_LENGTH_INVALID

次要傳回碼;LUA 動詞命令是以 LUA lua_verb_length 非預期的值發出。

LUA_STATE_CHECK
主要傳回碼;因為發出的動作處於無效狀態,所以無法執行。

LUA_NO_RUI_SESSION

次要傳回碼;針對此動詞指定的 LU 名稱, RUI_INIT 尚未順利完成。

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 錯誤。

  • TPs 電腦上的 SnaBase 發生 ABEND。

    LUA_SESSION_FAILURE
    主要傳回碼;必要的 Host Integration Server 元件已終止。

    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
    主要傳回碼;發出作業系統呼叫之後,會收到未預期的作業系統傳回碼,並在次要傳回碼中指定。

備註

如果傳送時未使用 lua_flag1, RUI_READ可以無限期地等候。 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