HP-UX SNAplus2 R7 LUA Programmer's Guide

RUI Verbs
RUI_PURGE
This parameter is optional; if you do not specify the session ID, you must specify the LU name for the session
in the
lua_luname parameter.
lua_data_ptr
A pointer to the RUI_READ VCB that is to be purged.
lua_post_handle
UNIX
A pointer to a callback routine that LUA will call to indicate completion if the verb completes asynchronously.
WINDOWS
If the VCB is used in an RUI function call, set this field to an event handle. If the VCB is used in a WinRUI
function call, this field is reserved.
For more information, see Chapter 2, Designing and Writing LUA Applications.
4.4.2 Returned Parameters
LUA always returns the following parameter:
lua_flag2.async
This flag is set to
1 if the verb completed asynchronously, or 0 (zero) if the verb completed synchronously.
Other returned parameters depend on whether the verb completed successfully; see the following sections.
Successful Execution
If the verb completed successfully, the following parameters are returned:
lua_prim_rc
LUA_OK
lua_sid
If the application specified the lua_luname parameter when issuing this verb, rather than specifying the session
ID, LUA supplies the session ID.
Unsuccessful Execution
If a verb does not complete successfully, LUA returns a primary return code to indicate the type of error and a
secondary return code to provide specific details about the reason for unsuccessful execution.
Verb Canceled
The following return codes indicate that the verb did not complete successfully because it was canceled by another
verb:
lua_prim_rc
LUA_CANCELLED
lua_sec_rc
LUA_TERMINATED
An RUI_TERM verb was issued while this verb was pending.
Parameter Check
The following return codes indicate that the verb did not complete successfully because a supplied parameter was
in error:
81