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

    This function returns the current paste-merge operation that will be used when an image from the clipboard is merged into the currently loaded image using IG_clipboard_paste_merge_ex().

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_clipboard_paste_op_get (  
            HIGEAR hIGear, 
            LPAT_MODE lpOperation
    );
    

    Arguments:

    Name Type Description
    hIGear HIGEAR HIGEAR handle of image.
    lpOperation LPAT_MODE A long pointer to an integer constant of type AT_MODE. This will return the current setting for the kind of paste merge operation that will be performed.

    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:

    Clipboard, Image Processing

    Example:

     
    Copy Code
    HIGEAR hIGear;      /* HIGEAR handle of image    */
    AT_MODE nOperation;  /* current setting for paste-merge operation */
    AT_ERRCOUNT nErrcount    /* # of IG errors currently on the stack  */
    nErrcount = IG_clipboard_paste_op_get (hIGear, &nOperation);
    

    Remarks:

    See the description of IG_clipboard_paste_op_set() for the list of possible settings.