Wait (4)

Top Previous Next

This function determines whether the Host session is in an inhibited state. If, for some reason, the session is in an inhibited state, this function will signal your application with a message when either the inhibited state expires or your wait period has expired. The amount of time to wait is set with the Set Session Parameters (9) function.

Prerequisite Functions

Connect Presentation Space (1)

Syntax

WinHLLAPIAsync(hWnd, lpwFunction, lpbyString, lpwLength, lpwReturnCode)

Call Parameters

Parameter	Description
Data String	NA
Data Length	NA
PS Position	NA

Return Codes

Code	Description
WHLLOK	The PS is uninhibited and ready for input.
WHLLNOTCONNECTED	Your WinHLLAPI application is not connected to a valid host session.
WHLLPSBUSY	Function timed out while still inhibited.
WHLLNHIBITED	The PS is inhibited.
SHLLSYSERROR	The function failed due to a system error.
WHLLCANCEL	The asynchronous function was cancelled.

Remarks

Asynchronous Wait is used to notify the calling application when the inhibited state of the PS is expired. When inhibited state has expired, this version of Wait will post a WinHLLAPIAsync message to the window specified by the hWnd. The session options TWAIT, LWAIT, and NWAITaffect the length of time that this function will wait. See Set Session Parameters (9) for details on these session options.

Note:

If NWAIT is specified in the session parameters and the application registers using revision 1.1 of the WinHLLAPI implementation, the WINHLLAPIAsync call will work the same as the WinHLLAPI call and not send a message. If revision 1.0 is being used then Wait will return a message immediately with the inhibited status of the PS.