HP-UX SNAplus2 R7 LUA Programmer's Guide

Designing and Writing LUA Applications
LUA Entry Points for Windows Applications
• If the returned version number is the same as the requested version number, the application can use this
Windows LUA implementation.
• If the returned version number is lower than the requested version number, the application can use this
Windows LUA implementation but must not attempt to use features that are not supported by the returned
version number. If it cannot do this because it requires features not available in the lower version, it
should fail its initialization and not attempt to issue any LUA verbs.
szDescription
A text string describing the Windows LUA software.
2.2.3 WinRUI
The application uses this function to issue an RUI verb. If the verb completes asynchronously, LUA will indicate
the completion by posting a message to the application’s window handle.
Before using the
WinRUI call for the first time, the application must use RegisterWindowMessage to obtain the
message identifier that LUA will use for messages indicating asynchronous verb completion. For more information,
see Section 2.2.3,
WinRUI.
Function Call
int WINAPI WinRUI (
HWND hWnd,
LUA_VERB_RECORD far * lpVCB
);
For the definition of the LUA_VERB_RECORD structure, see Chapter 3, LUA VCB Structure.
Supplied Parameters
Supplied parameters are:
hWnd
A window handle that LUA will use to post a message indicating asynchronous verb completion.
lpVCB
A pointer to the VCB structure for the verb. For the WinRUI function, the lua_post_handle parameter is
reserved; leave it as 0 (zero).
For more information about the VCB structure, see Chapter 3, LUA VCB Structure. For more information
about on its usage for individual verbs, see Chapter 4, RUI Verbs.
Note
The LUA VCB contains many parameters marked as “reserved”; some of these are
used internally by the SNAplus2 software, and others are not used in this version
but may be used in future versions. Your application must not attempt to access any
of these reserved parameters; instead, it must set the entire contents of the VCB to
zero to ensure that all of these parameters are zero, before it sets other parameters
that are used by the verb. This ensures that SNAplus2 will not misinterpret any of
its internally-used parameters, and also that your application will continue to work
with future SNAplus2 versions in which these parameters may be used to provide
new functions.
To set the VCB contents to zero, use memset:
memset(vcb, 0, sizeof(vcb));
31