ImageGear for C and C++ on Windows v19.1 - Updated
IG_err_error_get
API Reference Guide > Core Component API Reference > Core Component Functions Reference > Error Functions > IG_err_error_get

This function retrieves information about the record from error stack with the given index.

Declaration:

 
Copy Code
AT_BOOL ACCUAPI IG_err_error_get(
   UINT nLevel,
   UINT nIndex,
   LPCHAR lpszFileName,
   UINT nFNameSize,
   LPINT lpnLineNumber,
   LPAT_ERRCODE lpnCode,
   LPAT_INT lplValue1,
   LPAT_INT lplValue2,
   LPCHAR lpExtraText,
   UINT nETextSize
);

Arguments:

Name Type Description
nLevel UINT Level of errors to index. 0 means critical errors (function failure); greater levels denote warnings.
nIndex UINT Zero-based record index of the given level.
lpszFileName LPCHAR Pointer indicating where to return the source's file name where the error occurred.
nFNameSize UINT Size of the memory buffer lpszFileName.
lpnLineNumber LPINT Pointer indicating where to return the line number where the error occurred.
lpnCode LPAT_ERRCODE Pointer indicating where to return the error code.
lplValue1 LPAT_INT Pointer indicating where to return the first associated long value.
lplValue2 LPAT_INT Pointer indicating where to return the second associated long value.
lpExtraText LPCHAR Pointer indicating where to return the additional text description.
nETextSize UINT Size of the memory buffer lpExtraText.

Return Value:

Returns TRUE if the error information has been successfully retrieved; returns FALSE otherwise. Errors that occurred during this function call are not appended onto the error stack.

Supported Raster Image Formats:

This function does not process image pixels.

Sample:

None

Example:

 
Copy Code
AT_ERRCOUNT errCount;
errCount = IG_err_count_get();

Remarks:

The difference between this function and IG_err_record_get is that this index exists for records with the specified level, nLevel; not for all records on the stack.

See Also

IG_err_callback_get