ImageGear for C and C++ on Linux v20.0 - Updated
API Reference Guide > Core Component API Reference > Core Component Functions Reference > Callback Register Functions > IG_status_bar_CB_register

This function establishes a status bar callback function to be called by ImageGear during load, save, and print operations.


Copy Code
AT_ERRCOUNT ACCUAPI IG_status_bar_CB_register (
        LPFNIG_STATUS_BAR lpfnStatusBar, 
        LPVOID lpPrivate 


Name Type Description
lpfnStatusBar LPFNIG_STATUS_BAR Far pointer to a function to be established as your status bar callback function. ImageGear will call this function once for each raster (pixel row) processed during load, save, print, and image processing operations. The argument list and return value of this function must be as shown in the definition of function type LPFNIG_STATUS_BAR.
lpPrivate LPVOID Far pointer to private data of your own choosing.

Return Value:

Returns the number of ImageGear errors that occurred during this function call. If there are no errors, the return value is IGE_SUCCESS.

Supported Raster Image Formats:

This function does not process image pixels.


Copy Code
LPFNIG_STATUS_BAR    MyStatusBarCallback;    /* Declare type of function */
static DWORD      dwPrivateFlags;
IG_status_bar_CB_register ( MyStatusBarCallback, (LPVOID) &dwPrivateFlags );


ImageGear will call the named function once for each raster (row) processed, transmitting the Y position of that raster, the total number of rasters involved in the transfer, and the value of lpPrivate (pointer to your private data area). Your callback function can use this data to display a status bar showing percent completion, or for any other purpose.

To change to a different status bar function, or to change to a different private data area, call IG_status_bar_CB_register() again with your new callback function name and/or private data area address.

To disable status bar callbacks, call IG_status_bar_CB_register() with argument lpfnStatusBar = NULL.

See also the description for function type LPFNIG_STATUS_BAR.
Is this page helpful?
Yes No
Thanks for your feedback.