Jump to content

WinWaitForShell: Difference between revisions

From EDM2
changed some so not verbatim of IBM's toolkit documentation
added related function
Line 37: Line 37:


=== Related Functions ===
=== Related Functions ===
[[OS2 API:WinNotebookButtonFromID|WinNotebookButtonFromID]]


=== Notes ===
=== Notes ===

Revision as of 19:29, 10 May 2005

WinWaitForShell

WinWaitForShell(event)

Allows an application to wait for the Workplace Shell to become available.

Parameters

event - ULONG - input

The event being waited upon.

Constants

Constants defined for event:

Returns

Returns BOOL with the values of:

Module

Define (C/C++)

INCL_WINWORKPLACE

Export name/Ordinal

Calling conversion

Cdecl32

Example Code

BOOL rc;
...
rc = WinWaitForShell(WWFS_DESKTOPPOPULATED); // Desktop populated
...

Related Functions

WinNotebookButtonFromID

Notes

WinWaitForShell can not be called from detached processes. So a program started by a RUN= statement in config sys, can not rely on this method to wait for the shell to be up.

A message queue is not required for the thread which calls WinWaitForShell.

The prototype and defines for this function are defined in wpobject.h, which may be inaccessible if not compiling a WPS object class. Copy the defines and the prototype verbatim into your own code or headers for use. It is exported through os2386.lib in the OS/2 Warp 4 Toolkit.

OS Version Introduced

OS/2 Warp 4