Result codes and error processing

---

Description

Result codes and functions to deal with error information

Defines
#define	BFRESULT_OK   0
#define	BFRESULT_FAIL   -1
#define	BFRESULT_INVALIDARG   -2
#define	BFRESULT_INVALIDHANDLE   -3
#define	BFHANDLE   void *
Functions
BFEXPORT_FUNCDEC wchar_t const *	BFGetErrorMessage (const BFHANDLE errorinfo)
BFEXPORT_FUNCDEC wchar_t const *	BFGetExtendedErrorMessage (const BFHANDLE errorinfo)
BFEXPORT_FUNCDEC BFHANDLE	BFGetErrorCause (const BFHANDLE errorinfo)
BFEXPORT_FUNCDEC void	BFCloseErrorInfo (const BFHANDLE errorinfo)

---

Define Documentation

#define BFRESULT_OK   0

The function was sucessful

#define BFRESULT_FAIL   -1

The function failed

#define BFRESULT_INVALIDARG   -2

Invalid arguments were passed to the function

#define BFRESULT_INVALIDHANDLE   -3

Invalid handle was passed to the function

#define BFHANDLE   void *

An abstract reference to a request, response or other object

---

Function Documentation

BFEXPORT_FUNCDEC wchar_t const* BFGetErrorMessage

(

const BFHANDLE

errorinfo

)

Gets the single line error message. The message will a single line.

Parameters:

errorinfo

Handle returned by when another function failed

Returns:

message Pointer to a zero-terminated UNICODE message

BFEXPORT_FUNCDEC wchar_t const* BFGetExtendedErrorMessage

(

const BFHANDLE

errorinfo

)

Gets the extended error message. This message may contain multiple lines. For Java-based exceptions this message will include the stack trace.

Parameters:

errorinfo

Handle returned by when another function failed

Returns:

Pointer to a zero-terminated UNICODE message

BFEXPORT_FUNCDEC BFHANDLE BFGetErrorCause

(

const BFHANDLE

errorinfo

)

Gets the extended error message. This message may contain multiple lines. For Java-based exceptions this message will include the stack trace.

Parameters:

errorinfo

Handle returned by when another function failed

Returns:

Handle to the error which caused this one or NULL if no cause exists. This handle may be used with BFGetErrorMessage, BFGetExtendedErrorMessage and BFGetErrorCause allowing to developer to get and report the entire chain of causes. Unlike the error handles return my other functions this handle does NOT need to be closed using BFCloseErrorInfo although doing so will not cause as problem.

BFEXPORT_FUNCDEC void BFCloseErrorInfo

(

const BFHANDLE

errorinfo

)

Closes an error information handle.

Parameters:

errorinfo

Handle returned by when another function failed. To simplify using this API passing NULL to this function is valid and no action will be taken.