HP-UX SNAplus2 R7 LUA Programmer's Guide

RUI Verbs
RUI_INIT
The name of the PU that owns the LU to be used for the session. The name must be in ASCII, padded with
spaces on the right (
0x20). It must match a PU name defined in the SNAplus2 configuration.
lua_lunumber
The LU number of the LU to be used for the session. This must match the LU number of a type 0
–3LU
configured to use the specified PU.
An application can start multiple sessions by using multiple RUI_INIT verbs with a different LU for each
verb; it cannot start more than one session for the same LU.
wait_for_link
Normally, if the application issues RUI_INIT for an LU that cannot currently be used because the underlying
communications link is inactive, the RUI_INIT verb fails. Set this parameter to 1 to override this default
behavior so that LUA waits for the link and LU to become active before RUI_INIT completes, or 0 (zero) to
use the default behavior.
4.2.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
if the verb completed synchronously. (RUI_INIT
will always complete asynchronously, unless it returns an error such as
LUA_PARAMETER_CHECK.)
Other returned parameters depend on whether the verb completed successfully; see the following sections.
Successful Execution
If the verb executes successfully, LUA returns the following parameters.
lua_prim_rc
LUA_OK
lua_sid
A session ID for the new session. This can be used by subsequent verbs to identify this session.
lua_luname
The name of the LU used by the new session. If the LU name in the request parameters specified an LU
pool, or if the application used the extended form of RUI_INIT and specified the PU name and LU number
instead of the LU name, SNAplus2 uses this parameter to return the name of the actual LU assigned to the
session. Subsequent verbs must use this returned name (not the name specified in the request parameters) to
identify the session.
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
72