AIDA_boGetTime

The AIDA_boGetTime function reads the current time of an AIDA component.

bool AIDA_boGetTime(
  handle hStack,
  byte bLevel,
  tstTimeVal *pstTime
);

Parameters

hStack

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

bLevel

Specifies the AIDA stack level where the time shall be passed from to the application. This parameter can be set to 0 to read the time from the first loaded component of the AIDA stack.

pstTime

A pointer to the time structure where the time shall be written to. The format of the time information is as described for tstTimeVal. AIDA_boGetTime always returns absolute time values.

Return Values

AIDA_boGetTime 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

When an application reads time information from AIDA components other than the first one added to a stack the time information may not be accurate due to latencies when passing the function call through the stack levels. Furthermore time information is not synchronized between different stack levels.

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