CardGetEventMask

The CardGetEventMask function retrieves either the driver's global event mask or the event mask for a particular socket and function. The event mask specifies the events that trigger a callback.

Syntax

STATUS CardGetEventMask( CARD_CLIENT_HANDLE hCardClient PCARD_EVENT_MASK_PARMS pMaskParms );

Parameters

hCardClient: Specifies a client handle obtained from CardRegisterClient.
pMaskParms: Specifies a pointer to a CARD_EVENT_MASK_PARMS structure.

Return Values

If the function succeeds, the return value is CERR_SUCCESS; otherwise, it is one of the following values:

Value	Description
CERR_BAD_ARGS	Indicates the pointer specified for pMaskParms is invalid.
CERR_BAD_HANDLE	Indicates the driver handle specified for hCardClient is invalid.
CERR_BAD_SOCKET	Indicates the identifier specified for the hSocket member of the CARD_EVENT_MASK_PARMS structure is invalid .

Remarks

If an installable device driver used CardRequestSocketMask to associate a socket and function pair with an event mask, this function retrieves the event mask for the specified socket and function; otherwise it retrieves the global event mask as set initially by CardRegisterClient.

This function returns the current event mask in the fEventMask member of the CARD_EVENT_MASK_PARMS structure. If the function returns a global event mask, it ignores the structure's socket identifier member hSocket.