ImageGear for C and C++ on Windows v19.3 - Updated
IG_batch_CB_register
API Reference Guide > Core Component API Reference > Core Component Functions Reference > Callback Register Functions > IG_batch_CB_register

This function registers one of two available batch callback functions.

Declaration:

 
Copy Code
AT_ERRCOUNT ACCUAPI IG_batch_CB_register(
        LPVOID lpfnBatchCB,
        AT_MODE nCBType,   
        LPVOID lpPrivate 
);

Arguments:

Name Type Description
lpfnBatchCB LPVOID A far pointer to the scan callback function you would like to register.
nCBType AT_MODE Set to the type of callback being registered. Use one of the following ImageGear-defined constants:
  • IG_BATCHCB_BEFORE_OPEN
  • IG_BATCHCB_BEFORE_SAVE
lpPrivate LPVOID Optional pointer to from which to pass and receive data. Set this to NULL if this is not required.

Return Value:

Returns the number of ImageGear errors that occurred during this function call.

Supported Raster Image Formats:

All pixel formats supported by ImageGear for C and C++.

Sample:

None

Example:

See example the code for the LPFNIG_BATCH_BEFORE_SAVE and LPFNIG_BATCH_BEFORE_OPEN functions.

Remarks:

This function registers one of two available batch callback functions.