Method MasterObject()->describe_backtrace()

Method describe_backtrace

string describe_backtrace(mixed exception)

Description

Called by various routines to format a readable description of an exception.

Parameter exception

Something that was thrown. Usually an Error.Generic object, or an array with the following content:

Array
`string msg`	Error message.
`array(Pike.BacktraceFrame\|array(mixed)) backtrace`	Backtrace to the point where the exception occurred.

Returns

Returns a string describing the exeception.

Note

Usually added by the initialization code the global name space with add_constant().

See also

predef::describe_backtrace()

Method describe_backtrace

string describe_backtrace(mixed trace, void|int linewidth, int|void flags)

Description

Return a readable message that describes where the backtrace trace was made (by backtrace).

It may also be an error object or an array (typically caught by a catch), in which case the error message also is included in the description.

Parameter trace

Backtrace to format.

Parameter linewidth

Number of characters per line. Pass -1 to disable wrapping of the output. Defaults to the width of the Stdio.stdin tty (if known). Otherwise defaults to a large number.

Parameter flags

Flags affecting the backtrace behavior.

`1`	Reserved (inhibit Roxen testsuite complaints).
`2`	Inhibit rendering of container values.

Note

For convenience this function is also made available as predef::describe_backtrace().

Note

The flags argument was added in Pike 9.0.