AIDA_boGetEventTypes

The AIDA_boGetEventTypes function reads what types of events from which stack levels will be received.

bool AIDA_boGetEventTypes(
  handle hStack,
  dword *pdwStackLevelMask,
  dword *pdwEventMask
);

Parameters

hStack

Specifies the AIDA stack where the new settings shall take effect. This is a handle to an AIDA stack created by one of the AIDA stack manipulation functions.

pdwStackLevelMask

After successful execution *pdwStackLevelMask contains the AIDA stack levels where events may be passed to the application. Every bit corresponds to a stack level returned by the AIDA_bAddToStack function (bit 0 -> stack level 0 ... bit 31 -> stack level 31).

pdwEventMask

After successful execution *pdwEventMask contains the types of events that have to be received. The possible values are derived from AIDA_tenEventType.

Return Values

AIDA_boSetEventTypes returns True in case of success.

In case of failure the function will return False. The application can retrieve the error code using AIDA_iGetError.

Remarks

If an AIDA component can not process an event generated by a lower component it will pass it to the next higher AIDA component in the stack. So it may happen that the AIDA_boWaitEvent function returns events of lower components. An application is able to block the generation of these eventually unwanted events using the AIDA_boSetEventTypes function.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Linux: Requires a kernel supporting ELF binaries.
  Header: Declared in bsk_aida.h, also requires portab.h.
  Import Library (Windows): Use BSK_AIDA.lib.

See Also

AIDA Overview, AIDA Functions, AIDA_pstCreateEvent, AIDA_pstCreateEventEx, AIDA_boSetEventID, AIDA_boDeleteEvent, AIDA_pstCloneEvent, AIDA_boSendEvent, AIDA_boReceiveEvent, AIDA_boWaitEvent, AIDA_boSetEventTypes