WaitForAPIReady

Other versions of this page are also available for the following:

• Windows Embedded CE 6.0 R3

8/28/2008

This function indicates whether the specified API set has been registered. This is a non-polling version of the IsAPIReady function. The IsAPIReady function, which polls, is deprecated.

Syntax

DWORD WaitForAPIReady(
DWORD dwAPISlotIndex,
DWORD dwTimeout
);

Parameters

• dwAPPISlotIndex
  Index of the API slot to wait for.

• dwTimeout
  Timeout to wait for. Can be any value of milliseconds between zero and INFINITE.

Return Value

• WAIT_FAILED
  Invalid slot index or a non-timeout failure.

• WAIT_OBJECT_0
  API set is registered within the specified timeout.

• WAIT_TIMEOUT
  API set is not registered within the specified timeout.

Remarks

The Pkfuncs.h header file contains definitions for all the API set IDs.

Windows supports registering up to 128 API sets, but which sets are registered and how many of them are used is configurable by the OEM. Even a maximal configuration only registers a subset of the full 128 sets. The following code example shows some of the kernel-defined API sets. Others are defined in specific projects.

#define SH_WIN32        0
#define SH_CURTHREAD    1
#define SH_CURPROC      2
#define SH_CURTOKEN     3
#define HT_EVENT        4 // Event handle type
#define HT_MUTEX        5 // Mutex handle type
#define HT_APISET       6 // kernel API set handle type
#define HT_FILE         7 // open file handle type
#define HT_FIND         8 // FindFirst handle type
#define HT_DBFILE       9 // open database handle type
#define HT_DBFIND       10 // database find handle type
#define HT_SOCKET       11 // WinSock open socket handle type
#define HT_CRITSEC      12 // Critical section
#define HT_SEMAPHORE    13 // Semaphore handle type
#define HT_FSMAP        14 // mapped files
#define HT_WNETENUM     15 // Net Resource Enumeration
#define HT_AFSVOLUME    16 // file system volume handle type
#define SH_GDI          80
#define SH_WMGR         81
#define SH_WNET         82 // WNet APIs for network redirector
#define SH_COMM         83 // Communications not COM
#define SH_FILESYS_APIS 84 // File system APIS
#define SH_SHELL        85
#define SH_DEVMGR_APIS  86 // File system device manager
#define SH_TAPI         87
#define SH_CPROG        88 // Handle to the specified API set
#define SH_SERVICES     90
#define SH_DDRAW        91
#define SH_D3DM         92

Requirements

See Also

Reference

Kernel Functions
IsAPIReady

Concepts

Determining if an API is Ready
New Kernel APIs