AIDA_boAttachParam

The AIDA_boAttachParam function attaches a temporary or permanent parameter to a given AIDA event.

bool AIDA_boAttachParam(
  AIDA_tstEvent *pstEvent,
  byte bLevel,
  bool boTemporary,
  const xchar *xsName,
  ...
);

Parameters

pstEvent

The AIDA event to which the parameter shall be attached. The attached parameter takes effect as soon as the event processed in the given stack level.

bLevel

The stack level where the parameter becomes valid and will be detached from the event. bLevel must be greater than or equal to the stack level of the given event.

boTemporary

When the value of boTemporary is true the attached parameter is only valid as long as the event exists. A value of false makes the changes permanent.

xsName

The name of the parameter.

...

Value of the parameter.

Return Values

AIDA_boAttachParam returns true on success.

If the parameter could not be attached the function returns false. The application can retrieve the error code using AIDA_iGetError.

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