PXCV_Err_FormatFacility

<< Click to Display Table of Contents >>

Navigation:  Error Handling >

PXCV_Err_FormatFacility


 

pdf-xchange-editor-simple-sdk_100x100 PXCV_Err_FormatFacility

 


 

PXCV_Err_FormatFacility returns information on where errors occurred for the error code specified.

 

LONG  PXCV_Err_FormatFacility(

     HRESULT errorcode,

     LPSTR buf,

     LONG maxlen

);

 

Parameters

 

errorcode

[in] Specifies the HRESULT that a function returned.

 

buf

[out] Specifies a pointer to a buffer where the error facility information 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 retrieve information about an 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 the buffer (including a null-terminating character).