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

    This callback function is called once for each raster (row) in the image.

    Declaration:

     
    Copy Code
    typedef BOOL (ACCUAPI LPFNIG_STATUS_BAR) (
            LPVOID lpPrivate,  
            AT_PIXPOS cyPos, 
            AT_DIMENSION dwHeight
    );
    

    Arguments:

    Name Type Description
    lpPrivate LPVOID Far pointer to private data area, as specified in your call to IG_status_bar_CB_register() function.
    cyPos AT_PIXPOS Y position in the image of this raster (row). Calls for the rows are not guaranteed to be in a particular order.
    dwHeight AT_DIMENSION Total number of rasters (rows) in the image.

    Return Value:

    Your LPFNIG_STATUS_BAR() callback function should return TRUE if ImageGear should continue the load, save, or print operation it is performing, or FALSE if ImageGear should terminate the operation, placing an IGE_INTERRUPTED_BY_USER error on the error stack.

    Supported Raster Image Formats:

    This function does not process image pixels.

    Sample:

    Display, Image Processing, Poster, Print, FlashPix

    Example:

     
    Copy Code
    BOOL ACCUAPI StatusBar( 
       LPVOID            lpPrivate,    /* Private data passed in  */
       AT_PIXPOS            cyPos,     /* Y position in the image */
       AT_DIMENSION      dwHeight      /* Height of the image */
       );
      ...
        /* register the status bar callback function */
        err_count = IG_status_bar_CB_register(StatusBar, &si);
    if (err_count == 0)
    {
        fSBEnabled = TRUE;
        CheckMenuItem(GetMenu( hWnd),ID_OPTIONS_PROGRESSBAR,MF_CHECKED);
    }
                            }
    else
                            {
       /* deregister SB function */
       /* deregister the status bar callback function */
       err_count = IG_status_bar_CB_register( NULL, NULL);
    if (err_count == 0)
    {
       fSBEnabled = FALSE;
       CheckMenuItem(GetMenu( hWnd),ID_OPTIONS_PROGRESSBAR,MF_UNCHECKED);
    }
                            }
      ...
    

    Remarks:

    This is the type of the callback function you specify in calling IG_status_bar_CB_register().

    The calls will not necessarily be in row order. See also the description for function IG_status_bar_CB_register().