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_merge
In This Topic
    IG_clipboard_paste_merge
    In This Topic

    This function retrieves compatible media from the clipboard, if available, and "places" or merges the clipboard media into the specified image at the specified coordinates.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_clipboard_paste_merge(
       HIGEAR hIGear,
       AT_PIXPOS nLeftPos,
       AT_PIXPOS nTopPos
    );
    

    Arguments:

    Name Type Description
    hIGear HIGEAR HIGEAR handle of the image into which the clipboard media will be merged.
    nLeftPos AT_PIXPOS X-coordinate of the hIGear to which the clipboard media will be merged.
    nTopPos AT_PIXPOS Y-coordinate of the hIGear to which the clipboard media will be merged.

    Return Value:

    Returns 0 if successful. Otherwise, returns the number of ImageGear errors that occurred during this function call.

    Supported Raster Image Formats:

    This function does not process image pixels.

    Sample:

    C Clipboard, C Image Processing

    Remarks:

    The compatible data types supported on Windows systems are: CF_DIB, CF_BITMAP, CF_ENHMETAFILE, and CF_METAFILEPICT. Compatible data must be available on the clipboard for this API to be successful.

    To determine the number of errors currently on the error stack use IG_error_check. After fetching all error information you need using IG_error_get, use IG_error_clear to clear the stack.

    See Also:

    IG_clipboard_paste_merge_ex