HP-UX SNAplus2 R7 LUA Programmer's Guide

Designing and Writing LUA Applications
LUA Entry Points for Windows Applications
2.2.4 WinRUIGetLastInitStatus
The application uses this function to determine the status of a previous RUI_INIT verb that is still outstanding. It
can use the returned information to decide whether to cancel the session initiation (by issuing RUI_TERM) or to
wait for the session to be established.
The function can be used to do any of the following:
• Request information about the current status of the session initiated by a specific RUI_INIT verb.
• Request asynchronous notification of changes to session status for a specific session or for all sessions. When
the session status changes, LUA will indicate this by either posting a message to the application’s window
handle or by signaling the application’s event handle.
• Cancel a previous request for asynchronous notification of changes to session status.
Before using the
WinRUI call for the first time, the application must use WinRUIStartup to register as
a Windows LUA application. If it requires asynchronous notification of status changes, it must also use
RegisterWindowMessage to obtain the message identifier that LUA will use for this notification. For more
information about these calls, see Section 2.2.2,
WinRUIStartup and Section 2.2.4, WinRUIGetLastInitStatus.
Function Call
int WINAPI WinRUIGetLastInitStatus (
DWORD Sid,
HANDLE StatusHandle,
DWORD NotifyType,
BOOL ClearPrevious
);
Supplied Parameters
Supplied parameters are:
Sid
To obtain information about the session status for a specific RUI_INIT verb, or to cancel a previous request
for notification of session status changes for this verb, specify the session ID returned on the initial return
from the RUI_INIT verb.
To request notification on session status changes for all outstanding RUI_INIT verbs, specify 0 (zero). In this
case, the StatusHandle parameter must specify a valid Windows handle, because the information will always
be returned asynchronously.
To cancel notification of session status changes for all outstanding RUI_INIT verbs, specify 0 (zero).
StatusHandle
To obtain the current session status for a specific RUI_INIT verb, without requesting notification of subsequent
changes, specify a null handle.
To request notification on session status changes, either for a specific RUI_INIT verb or for all outstanding
RUI_INIT verbs, specify a Windows handle or an event handle that LUA will use when the session status
changes.
If the ClearPrevious parameter is set to TRUE, to cancel a previous notification request, LUA ignores this
parameter.
NotifyType
If requesting asynchronous notification, this parameter determines how LUA should identify the RUI_INIT
verb on the asynchronous notification message. Allowed values:
WLUA_NTFY_MSG_CORRELATOR
The StatusHandle parameter contains a window handle. Identify the verb using the lua_correlator value
supplied on the RUI_INIT verb.
33