RUI()

Provides event notification for all RUI verbs.

Syntax

void WINAPI RUI (LUA_VERB_RECORD* vcb);

The value returned in lua_prim_rc indicates whether asynchronous notification will occur. If the field is set to LUA_IN_PROGRESS, asynchronous notification will occur through event signaling. If the flag is not LUA_IN_PROGRESS, the request completed synchronously. Examine the primary return code and secondary return code for any errors.

The verb always returns asynchronously. Verb values including lua_prim_rc cannot be tested until the event has been posted through event signalling. Examine the primary return code and secondary return code for any errors.

The application must provide a handle to an event in the lua_post_handle parameter of the verb control block. The event must be in the not-signaled state.

Returned Values

The value returned in lua_flag2.async indicates whether asynchronous notification will occur. If the flag is set (nonzero), asynchronous notification will occur through event signaling. 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

The application must provide a handle to an event in the lua_post_handle parameter of the verb control block. The event must be in the not-signaled state.

When the asynchronous operation is complete, the application is notified by the signaling of the event. Upon signaling of the event, examine the primary return code and secondary return code for any error conditions. See also: WinRUI.