Purpose

WinWaitForShell() determines if various events in the Workplace Shell(R) have taken place.

Syntax

#define
#include  os2.h>

BOOL EXPENTRY WinWaitForShell()

(ULONG ulEvent)

Parameters

ulEvent (ULONG) input

ulEvent has the following flags which indicate which event is to be queried. One, and only one, of these flags must be turned on.

WWFS_DESKTOPCREATED

Desktop has been created.
WWFS_DESKTOPOPENED
A view of the Desktop has been opened.
WWFS_DESKTOPPOPULATED
The desktop has been populated..
WWFS_QUERY
Query if the event has taken place. If this flag is not turned on then this call will block until the event has taken place.

Returns

rc (BOOL) returns

Success indicator.

True

Event has taken place
False
Event has not taken place
Possible returns from WinGetLastError

PMERR_INVALID_PARAMETER (0x1208)

One of the defined WWFS_DESKTOP* flags was not passed in ulEvent.

Remarks

This function can be used to either determine if a Workpalce Shell event has taken place or wait until that event has taken place. Set ulEvent to one of the WWFS_DESKTOP* #defines above.

To block until the event has occurred, do not turn on the WWFS_QUERY flag.

Simply to query if the event has occurred and not to wait for it to occur, turn on the WWFS_QUERY flag.

Example Code

This example checks (non-blocking) to see if the Workplalce Shell Desktop to be populated has been populated or not.

#define#include  os2.h>

BOOL fOccurred;

fOccurred + WinWaitForShell(WWFS_DESKTOPPOPULATED | WWFS_QUERY);
if (fOccurred)
   {
    /* The Desktop has been populated */
   }
else
   {
    /* The Desktop has not been populated */

---

[Back] [Next]