AIDA_boSetStackOnline

The AIDA_boSetStackOnline function sets an AIDA stack to online state.

bool AIDA_boSetStackOnline(
  handle hStack
);

Parameters

hStack

Specifies the AIDA stack to be set online. This is a handle to an AIDA stack created with AIDA_hCreateStack.

Return Values

AIDA_boSetStackOnline returns true if the stack accepts the request.

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

Remarks

AIDA_boSetStackOnline internally generates and sends an AIDA stack status event where AIDA_nStackForcedOffline in the dwStatusFlags member of the event's AIDA_tstStackStatus structure is set.

Note that this special type of event is processed synchronously (see AIDA_boSendEvent for further details).

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