Solution::GetErrorText method

Retrieve the text for a specified error code.

Syntax

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

Parameters

axeError [in]

An HRESULT that was returned by an Axe API.

errorList [out]

An error list that contains a single AxeErrorInfo object with all of the information about the requested error.

Return value

If AXE retrieves the text successfully, this method returns S_OK.

If no string can be found for the specified error, this method returns E_FAIL.

If an ErrorList or AxeErrorInfo object could not be created due to available memory limitations, this method returns E_OUTOFMEMORY.

Remarks

A solution application can use this API to convert an error code reported by the AXE engine into a human-readable error text to display to the user. The information about the error is returned in an AxeErrorInfo object that is contained within an ErrorList.

Managed code uses the Solution.GetErrorText | getErrorText method

Requirements

See also

Solution