ImageGear for C and C++ on Windows v21.0 - Updated
API Reference Guide / Core Component API Reference / Core Component Functions Reference / Error Functions / IG_err_callback_get
In This Topic
    IG_err_callback_get
    In This Topic

    This function obtains error stack callback data and functions that are called to signal error stack changes for the current thread.

    Declaration:

     
    Copy Code
    AT_ERRCODE ACCUAPI IG_err_callback_get(
       LPVOID FAR* lplpPrivate,
       LPFNIG_ERRSTACK_ADD FAR* lplpfnAddCB,
       LPFNIG_ERRSTACK_CLEAR FAR* lplpfnClearCB
    );
    

    Arguments:

    Name Type Description
    lplpPrivate LPVOID FAR* Pointer to LPVOID variable to retrieve the private data that is passed to *lplpfnAddCB and *lplpfnClearCB callbacks. NULL is acceptable.
    lplpfnAddCB LPFNIG_ERRSTACK_ADD FAR* Pointer to LPFNIG_ERRSTACK_ADD variable to retrieve the callback function that is called after the record is added to the error stack. NULL is acceptable.
    lplpfnClearCB LPFNIG_ERRSTACK_CLEAR FAR* Pointer to LPFNIG_ERRSTACK_CLEAR variable to retrieve the callback function that is called after the error stack is cleared. NULL is acceptable.

    Return Value:

    Returns the code of the ImageGear error that occurred during this function call. A value of zero means no errors have occurred. 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:

    Filters, Multimedia, Flashpix

    Example:

     
    Copy Code
    LPVOID                lpPrivate;
    LPFNIG_ERRSTACK_ADD   lpfnAdd;
    LPFNIG_ERRSTACK_CLEAR lpfnClear;
    AT_ERRCODE iErrCode;
    iErrCode = IG_err_callback_get(&lpPrivate, &lpfnAdd, &lpfnClear);
    

    Remarks:

    Callback data and functions can be set using the IG_err_callback_set function.

    Each thread has its own independent error stack. There are two types of callbacks - local to thread and global. This API allows you to get the thread specific callbacks. Use IG_errmngr_callback_get to get the global data and callbacks.

    See Also

    IG_err_callback_set