WinRUI

Provides asynchronous message notification for all RUI verbs.

Syntax

int WINAPI WinRUI (HWND hWnd,LUA_VERB_RECORD* vcb);

Parameters
hWnd: Window handle to receive completion message.
vcb: Pointer to verb control block.

Returned Values

The function returns a value indicating whether the request was accepted by the RUI for processing. A returned value of 0 indicates that the request was accepted and will be processed. A value other than 0 indicates an error. Possible error codes are as follows:

WLUAINVALIDHANDLE: The window handle provided is not valid.

The value returned in lua_flag2.async indicates whether asynchronous notification will occur. If the flag is set (nonzero), asynchronous notification will occur through a message posted to the application's message queue. If the flag is not set, the request completed synchronously. Examine the primary return code and secondary return code for any error conditions.

Usage Notes

Upon completion of the verb, the application's window hWind receives the message returned by RegisterWindowMessage with WinRUI as the input string. The lParam argument contains the address of the VCB being posted as complete. The wParam argument is undefined. It is possible for the request to be accepted for processing (the function call returns 0), but rejected later with a primary return code and secondary return code set in the VCB. Examine the primary return code and secondary return code for any error conditions.

If the application calls WinRUI without first initializing the session using WinRUIStartup, an error is returned.