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_attribute_get
In This Topic
    IG_GUI_page_attribute_get
    In This Topic

    This function returns the current setting for the GUI Page attribute indicated by nAttributeID.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_GUI_page_attribute_get( 
            HWND hwndPage,   
            AT_MODE nAttributeID, 
            LPVOID lpData 
    );
    

    Arguments:

    Name Type Description
    hwndPage HWND Windows handle to the GUI Page Sorter window.
    nAttributeID AT_MODE An integer variable of type AT_MODE that indicates the attribute for which to get the current setting. These constants have the prefix IG_GUI_PAGE_ and are defined in accucnst.h.
    lpData LPVOID The current setting of the page attribute referred to by nAttributeID.

    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.

    Sample:

    None

    Example:

     
    Copy Code
    UINT nThreshold;
    /*Get the current antialiasing threshold */
    IG_GUI_page_attribute_get(hWndPag, IG_GUI_PAGE_ALIAS_THRESHOLD, (LPVOID)& nThreshold);
    

    Remarks:

    See IG_GUI_page_attribute_set() for a complete description of the attributes that can be changed.

    Currently it is possible to change the font title for Page windows that is created by IG_GUI_page_window_create(). To set the font, use IG_GUI_page_attribute_set() and to get the font use IG_GUI_page_attribute_get() with the IG_GUI_PAGE_FONT_TITLE option. As in the case of a thumbnail window, the user is responsible for creating and deleting the font.