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

仅当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_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

指示 LUA 接口谓词在设置为 1 时异步完成。

lua_resv56
保留，应设置为零。

lua_encr_decr_option
保留，应设置为零。

返回代码

LUA_OK
主要返回代码；谓词已成功执行。

LUA_CANCELED
主返回代码;谓词未成功完成，因为它已被另一个谓词取消。

LUA_TERMINATED

辅助返回代码; RUI_TERM 是在 RUI_PURGE 挂起时发出的。

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_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。
) LAN 错误 (，事务程序 (TP) 与物理单元 (PU) 2.1 节点之间的连接中断。
TP 计算机上的 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.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

语法

成员

返回代码

注解

另请参阅

其他资源