AifFault::fault Method [AX 2012]

Throws a single fault that has the error message to the end user.

X++
Copy 
client server public static Exception fault(
    str _reason, 
    str _code, 
   [AifXml _detailXml, 
    URL _helpURL, 
    container _parameters])

Run On

Called

Parameters

_reason
Type: str
The reason the fault occurred.
_code
Type: str
The code of the fault.
_detailXml
Type: AifXml Extended Data Type
The details of the fault in XML; optional; optional.
_helpURL
Type: URL Extended Data Type
A URL that specifies the path of the internal Help system that can be used to open the Help viewer and present longer, explanatory text; optional.
_parameters
Type: container
A container that contains the parameters that are used to create the _reason String via strFmt; optional.

Return Value

Type: Exception Enumeration
The exception that is thrown to the end user.

If the value of the _reason parameter is a label ID (i.e. in the form "@SYSnnnnn"), strFmt will be used to create a reason String by substituting the value of the _parameters parameter.

Show: