Name

RUI_PURGE − Purges an active RUI_READ request. 
 
 
 

FORMAT

#include <lua_c.h>
 
void RUI(LUA_VERB_RECORD ∗rui_purge_vcb);
 
 
 
 

Parameter

rui_purge_vcb
 
 
A pointer to an LUA_VERB_RECORD structure appropriately initialized for the RUI_PURGE verb. 
 
 
 

Required Verb Control Block Fields

common.lua_verb
 
 
An unsigned short value specifying the verb code LUA_VERB_RUI. 
 

common.lua_verb_length
 
 
An unsigned short value specifying the length of the verb control block. Specify the value LUA_COMMON_LENGTH. 
 

common.lua_post_handle
 
 
A pointer to a sem_t structure specifying the DIGITAL UNIX semaphore that the interface should use for asynchronous calls.  See the DIGITAL UNIX sem_init() man page for more information about the data type of this parameter. 
 

common.lua_opcode
 
 
An unsigned short value specifying the verb opcode.  Specify the value LUA_OPCODE_RUI_PURGE. 
 

common.lua_luname
 
 
An 8-element unsigned char array specifying the local LU name (in ASCII). If the name is fewer than 8 characters in length, pad the name with space characters. 
 
 

common.lua_cobol_ptr
 
 
 
This parameter is not currently implemented and should be set to NULL.
 

common.lua_sid
 
 
An unsigned int value specifying the session ID that the interface should use to identify the local LU. If this parameter is 0, the interface uses the common.lua_luname parameter. 
 

common.lua_data_ptr
 
 
An unsigned char pointer to the verb control block describing the RUI_READ verb to be purged. 
 

common.lua_flag3
 
 
This parameter is not currently implemented. Any fields set are ignored.
 
 
 
 

Optional Verb Control Block Fields

common.lua_correlator
 
 
A void ∗ pointer that can contain either a value or an address of a user-supplied data structure. The LUA application can use this parameter to correlate this verb control block with other user-supplied data structures.  The interface does not read from or write to this field. 
 
 
 

Returned Verb Control Block Fields

common.lua_prim_rc
 
 
An unsigned short value containing the primary error code. 
 
 

common.lua_sec_rc
 
 
An unsigned int value containing the secondary error code. 
 
 

common.lua_sid
 
 
An unsigned int value containing the session ID that subsequent verbs can use to specify the session to the interface. 
 

common.lua_flag2
 
 
An LUA_FLAG2 structure containing various flags that indicate how the interface executed the verb.  The following flag is returned:

async---If set, indicates that the interface is completing the verb asynchronously. 

Description

 
The RUI_READ request terminated by the RUI_PURGE request completes with the primary return code LUA_CANCELLED and a secondary return code of LUA_PURGED.
 

Primary Return Codes

LUA_OK
 

LUA_CANCELLED
 

LUA_COMM_SUBSYSTEM_ABENDED
 

LUA_COMM_SUBSYSTEM_NOT_LOADED
 

LUA_IN_PROGRESS
 

LUA_INVALID_VERB
 

LUA_INVALID_VERB_SEGMENT
 

LUA_PARAMETER_CHECK
 

LUA_SESSION_FAILURE
 
 

LUA_STATE_CHECK
 

LUA_UNEXPECTED_DOS_ERROR
 

LUA_UNSUCCESSFUL