Support::GetErrorText method

Retrieves an Axe error message given the Axe error code. This method allows an assessment to get a human-readable string explaining what an error code means.

Syntax

virtual HRESULT GetErrorText(
  [in]  HRESULT   axeError,
  [out] ErrorList **errorList
) = 0;

Parameters

axeError [in]

The HRESULT representing an Axe error code.

errorList [out]

A double pointer to an ErrorList object that is populated with an AxeErrorInfo structure that contains the error string.

Return value

If the function succeeds, it returns S_OK. If it fails, it returns an error value.

Remarks

This method enables an assessment to get a human-readable string explaining the meaning of an error code.

Managed code uses Support.GetErrorText | getErrorText method.

Requirements

Minimum supported client	Windows 7 [desktop apps only]
Minimum supported server	Windows Server 2008 R2 [desktop apps only]
Header	AxeRuntime.h
DLL	AxeCore.dll

See also

Support