AIDA_boSetEventTypes

The AIDA_boSetEventTypes function controls what types of events from which stack levels shall be generated.

bool AIDA_boSetEventTypes(
  handle hStack,
  dword dwStackLevelMask,
  dword dwEventMask
);

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.

dwStackLevelMask

Specifies 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). When dwStackLevelMask is set to AIDA_nAllStackLevels the aida system may pass events of any stack level to the application. When dwStackLevelMask is set to 0 the application receives only events of the highest component in the stack.

dwEventMask

Defines which types of events have to be received. The possible values are derived from AIDA_tenEventType. There is a special value AIDA_dwAllEvents that can be used if the function shall get an event of any type in the queue.

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_boGetEventTypes