wclGetErrorInfo(Integer,string,string,string,string) Method

Reads the error information.

Namespace: wclHelpers

function wclGetErrorInfo(const Error: Integer; out Framework: string;
 out Category: string; out Constant: string;
 out Description: string): Boolean; overload;

Parameters

Error: Type: Integer
The WCL error code.
Framework: Type: string
If the function completed with success on output contains the WCL Framework name that the error relates to.
Category: Type: string
If the function completed with success on output contains the error category.
Constant: Type: string
If the function completed with success on output contains the error constant name.
Description: Type: string
If the function completed with success on output contains the error description.

Return Value

Type: Boolean

If the function completed with success the returning value is True. Otherwise the function returns False.

Remarks

The function uses the errors.xml file located on our site. The file link is https://www.btframework.com/errors.xml.

Reference

wclHelpers