AIDA_dwGetStackStatus

The AIDA_dwGetStackStatus function returns the current status of an AIDA stack.

dword AIDA_dwGetStackStatus(
  handle hStack
);

Parameters

hStack

Specifies the AIDA stack where the status shall be read. This is a handle to an AIDA stack created with AIDA_hCreateStack.

Return Values

AIDA_dwGetStackStatus returns the current stack status as described for AIDA_tstEvent.unEventData.stStatus.dwStackStatusFlags..

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

Remarks

AIDA_dwGetStackStatus provides a possibility of receiving the current stack status in a synchronous way. This function is normally used together with the other stack manipulation functions.

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_boSetStackOnline, AIDA_boSetStackOffline, AIDA_boGetStatistics, AIDA_boResetStatistics