PXCV_Err_FormatErrorCode
PXCV_Err_FormatErrorCode provides error code information.
LONG PXCV_Err_FormatErrorCode(
HRESULT errorcode,
LPSTR buf,
LONG maxlen
);
Parameters
errorcode
[in] Specifies the HRESULT that a library function returned.
buf
[out] Specifies a pointer to a buffer where the error description is returned. Pass NULL for buf in order to determine the required buffer size.
maxlen
[in] Specifies the available buffer size in characters (including a null-terminating character).
Please note that all functions and parameters are case-sensitive.
Return Values
If the function fails to recognize an error code then the return value is negative.
If the function fails to find information on the error code then the return value is zero.
If the function successfully retrieves information and the parameter buf is NULL, then the return value is the number of characters required to store the description (including a null-terminating character).
If the function successfully retrieves information and the parameter buf is not NULL, then the return value is the number of characters written to a buffer (including a null-terminating character).