AZ::Dom::VisitorError Class Reference

Details of the reason for failure within a VisitorInterface operation. More...

#include <DomVisitor.h>

Public Member Functions
	VisitorError (VisitorErrorCode code)
	VisitorError (VisitorErrorCode code, AZStd::string additionalInfo)
VisitorErrorCode	GetCode () const
	Gets the error code associated with this error.
const AZStd::string &	GetAdditionalInfo () const
AZStd::string	FormatVisitorErrorMessage () const
	Provides a formatted, human-readable error description that can be used for logging purposes.

Static Public Member Functions
static const char *	CodeToString (VisitorErrorCode code)
	Helper method, translates a VisitorErrorCode to a human readable string.

Detailed Description

Details of the reason for failure within a VisitorInterface operation.

Member Function Documentation

GetAdditionalInfo()

const AZStd::string & AZ::Dom::VisitorError::GetAdditionalInfo

(

)

const

Gets a supplemental error info string from the error. Returns an empty string if no additional information was provided to the error.

---

The documentation for this class was generated from the following file:

• Code/Framework/AzCore/AzCore/DOM/DomVisitor.h