wclHelpersGetErrorInfo(Int32, String, String, String, String) Method |
Reads the error information.
Namespace: wclCommonAssembly: wclCommon (in wclCommon.dll) Version: 7.11.10.0 (7.11.10.0)
Syntax public static bool GetErrorInfo(
int Error,
out string Framework,
out string Category,
out string Constant,
out string Description
)
Public Shared Function GetErrorInfo (
Error As Integer,
<OutAttribute> ByRef Framework As String,
<OutAttribute> ByRef Category As String,
<OutAttribute> ByRef Constant As String,
<OutAttribute> ByRef Description As String
) As Boolean
public:
static bool GetErrorInfo(
int Error,
[OutAttribute] String^% Framework,
[OutAttribute] String^% Category,
[OutAttribute] String^% Constant,
[OutAttribute] String^% Description
)
Parameters
- Error Int32
- The WCL error code.
- Framework String
- If the function completed with success on output
contains the WCL Framework name that the error relates to.
- Category String
- If the function completed with success on output
contains the error category.
- Constant String
- If the function completed with success on output
contains the error constant name.
- Description String
- If the function completed with success on output
contains the error description.
Return Value
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.
See Also