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

    This function updates/refreshes the image in the GUI Page Sorter referenced by nPage.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_GUI_page_document_refresh(
            HWND hwndPage, 
            UINT nPage
    );
    

    Arguments:

    Name Type Description
    hwndPage HWND HIGEAR Windows handle to the GUI Page Sorter.
    nPage UINT Set to the UINT page number you would like to refresh/update.

    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:

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

    Sample:

    None

    Example:

     
    Copy Code
    HIGEAR hIGear;   /* HIGEAR handle of image   */
    AT_ERRCOUNT  nErrcount; /* Tally of IG errors on the stack */
    HWND  hwndPage; /* Windows handle of the Page Sorter*/
    UINT  nPage;    /* Page number of image to refresh  */
    nPage = 5;
    nErrcount = IG_GUI_page_document_refresh(hwndPage, nPage);
    

    Remarks:

    To refresh all of the images in the Page Sorter, call IG_GUI_page_document_update().