xInfo.add Method

Adds a string to the Infolog buffer.

Syntax

public Exception add(
    Exception exceptionType, 
    str string, 
   [str helpURL, 
    Object obj, 
    boolean buildprefix])

Run On

Called

Parameters

• exceptionType
  Type: Exception Enumeration
  A Exception system enumeration that indicates the kind of exception to add.

• string
  Type: str
  The text to display in the Infolog.

• helpURL
  Type: str
  The address of a help topic in the AOT.

• obj
  Type: Object Class
  An action object extending the SysInfoAction class that enables the user to perform an operation in connection with the error reported on the Infolog.

• buildprefix
  Type: boolean
  Optional parameter, that enables you to turn off the generation of prefix information that is used to provide context to Infolog messages.

Return Value

Type: Exception Enumeration
An Exception system enumeration value. For more information, see Exception Handling with try and catch Keywords.

Remarks

An example value for the helpURL parameter is 'KernDoc:\\\\Functions\\substr'.

This method should not be used directly. Instead, use the infolog.info, infolog.warning, infolog.error, or infolog.checkFailed method instead.

For more information about the exceptionType parameter, see Exception Handling with try and catch Keywords.

See Also

Reference

xInfo Class