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

    This function gets the type of mark that is created by the end user.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ART_GUI_tool_get(
            HIGEAR hIGear, 
            LPART_MARK_ATTRIBUTES lpMarkAttr
    );
    

    Arguments:

    Name Type Description
    hIGear HIGEAR HIGEAR handle to the image.
    lpMarkAttr LPART_MARK_ATTRIBUTES A far pointer that returns the type of mark to create. The return value of the dwType field is a constant beginning with the prefix ART_MARK_ , such as ART_MARK_FREEHAND_LINE.

    Return Value:

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

    Supported Raster Image Formats:

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

    Sample:

    Annotation

    Example:

     
    Copy Code
    HIGEAR  hIGear; /* HIGEAR handle of */ 
    /* image  */
    ART_MARK_ATTRIBUTES ma; /* Structure for */
    /* mark attributes */
    memset(&ma, 0, sizeof(ART_MARK_ATTRIBUTES));
    ART_GUI_tool_get(hIGear, &ma);
    

    Remarks:

    An error is set if hIGear does not reference a valid ImageGear handle.