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

    This function moves a mark to the back of the stacking order.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ART_mark_send_to_back(
            HIGEAR hIGear, 
            ART_MARK_INDEX hMarkIndex
    );
    

    Arguments:

    Name Type Description
    hIGear HIGEAR HIGEAR handle to the image.
    hMarkIndex ART_MARK_INDEX Mark identifier.

    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:

    None

    Example:

     
    Copy Code
    HIGEAR    hIGear;  /* HIGEAR handle of image */
    AT_ERRCOUNT nErrcount;  /* tally of IG errors on  */
          /* stack    */
    ART_MARK_INDEX hMarkIndex;  /* index for mark to  */
    /* bring to front   */
    nErrcount = ART_mark_selected_first(hIGear,&hMarkIndex);
    if (hMarkIndex != ART_MARK_INVALID)
    {
    nErrcount = ART_mark_send_to_back(hIGear,hMarkIndex);
    }
    

    Remarks:

    The mark must be repainted in order to see a change in the stacking order. Use ART_GUI_mark_paint() function.

    An error is set if any of the following conditions are met: