AIDA_hsGetPlainErrMsgX

The AIDA_hsGetPlainErrMsgX function returns the last, possibly extended, error message for the functions (currently only) AIDA_hRestoreStack, AIDA_hRestoreStackEx and AIDA_hRestoreStackRaw. The returned string must be freed after use by the application using AIDA_vFreeErrMsgX.
This function only exists in an ANSI version.

char *AIDA_hsGetPlainErrMsgX(
  int iError
  dword *pdwLen
);

Parameters

iError

Error code to get a plain text description for, possibly with extended error information.

pdwLen

NULL, or a pointer to a variable, which receives the length of the generated plain text description.

Return Values

AIDA_hsGetPlainErrMsgX returns a pointer to a plain text error message for a given error code. In contrast to AIDA_hsGetErrMsg returns a text without the leading "AIDA: ". If extended error information is available it is included in round brackets, e.g.: (component: "CAN.COMPONENT").

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_vSetError, AIDA_iGetError, AIDA_hsGetErrMsg, AIDA_vFreeErrMsgX, AIDA_hRestoreStack, AIDA_hRestoreStackEx, AIDA_hRestoreStackRaw