Serial Framework C++ Edition

◆ wclGetErrorInfo() [1/2]

bool wclGetErrorInfo ( const int  Error,
tstring Framework,
tstring Category,
tstring Constant,
tstring Description 
)

Reads the error information.

Parameters
ErrorThe WCL error code.
FrameworkIf the function completed with success on output contains the WCL Framework name that the error relates to.
CategoryIf the function completed with success on output contains the error category.
ConstantIf the function completed with success on output contains the error constant name.
DescriptionIf the function completed with success on output contains the error description.
Returns
If the function completed with success the returning value is true. Otherwise the function returns false.

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