4.3 PcmciaEventCreate()

PURPOSE

$\bullet$Convenience function for allocating and initializing a PCMCIA Plug and Play and power management event structure.

PROTOTYPE

WD_EVENT * DLLCALLCONV PcmciaEventCreate(
  WD_PCMCIA_ID deviceId,
  WD_PCMCIA_SLOT pcmciaSlot,
  DWORD dwOptions,
  DWORD dwAction);

PARAMETERS

Name	Type	Input/Output
$\bullet$deviceId	WD_PCMCIA_ID
$\gg$wManufacturerId	WORD	Input
$\gg$wCardId	WORD	Input
$\bullet$pcmciaSlot	WD_PCMCIA_SLOT
$\gg$uBus	BYTE	Input
$\gg$uSocket	BYTE	Input
$\gg$uFunction	BYTE	Input
$\gg$uPadding	BYTE	N/A
$\bullet$dwOptions	DWORD	Input
$\bullet$dwAction	DWORD	Input

DESCRIPTION

Name	Description
deviceId	PCMCIA card ID information structure:
$\bullet$ w ManufacturerId	PCMCIA Manufacturer ID to register to. If zero, register to all PCMCIA manufacturer IDs.
$\bullet$ wCardId	PCMCIA card ID to register to. If zero, register to all PCMCIA card IDs.
slot	PCMCIA slot information structure:
$\bullet$ uBus	PCMCIA bus number to register to. If zero, register to all PCMCIA buses.
$\bullet$ uSocket	PCMCIA socket to register to. If zero, register to all sockets.
$\bullet$ uFunction	PCMCIA function to register to. If zero, register to all functions.
dwOptions	Can be either zero or: $\bullet$WD_ACKNOWLEDGE - If set, the user can perform actions on the requested event before acknowledging it. The OS waits on the event until the user calls WD_EventSend(). If EventRegister() [4.4] is called, WD_EventSend() will be called automatically after the callback function exits.
dwAction	A bit-mask indicating which events to register to: Plug and Play events: $\bullet$WD_INSERT - Device was attached and configured by the operating system's Plug and Play manager $\bullet$WD_REMOVE - Device was un-configured and detached by the operating system's Plug and Play manager Device power state: $\bullet$WD_POWER_CHANGED_D0 - Full power $\bullet$WD_POWER_CHANGED_D1 - Low sleep $\bullet$WD_POWER_CHANGED_D2 - Medium sleep $\bullet$WD_POWER_CHANGED_D3 - Full sleep $\bullet$WD_POWER_SYSTEM_WORKING - Fully on Systems power state: $\bullet$WD_POWER_SYSTEM_SLEEPING1 - Fully on but sleeping $\bullet$WD_POWER_SYSTEM_SLEEPING2 - CPU off, memory on, PCMCIA on $\bullet$WD_POWER_SYSTEM_SLEEPING3 - CPU off, memory is in refresh, PCMCIA on aux power $\bullet$WD_POWER_SYSTEM_HIBERNATE - OS saves context before shutdown $\bullet$WD_POWER_SYSTEM_SHUTDOWN - No context saved

RETURN VALUE

Returns a new events structure for handling PCMCIA Plug and Plug and power management events, or NULL if the allocation failed.

REMARKS

• It is the responsibility of the caller to free the event structure returned by the function (using free()) when it is no longer needed.

EXAMPLE

PciEventCreate(deviceId, pcmciaSlot, WD_ACKNOWLEDGE, WD_INSERT | WD_REMOVE);