ImageGear for C and C++ on Linux v20.0 - Updated
API Reference Guide > Core Component API Reference > Core Component Functions Reference > Clipboard Functions > IG_clipboard_paste

This function creates a HIGEAR image by pasting the image on the system clipboard.


Copy Code
AT_ERRCOUNT ACCUAPI IG_clipboard_paste (
        LPHIGEAR lphIGear 


Name Type Description
lphIGear LPHIGEAR Far pointer to a variable of type HIGEAR, to receive the HIGEAR handle of the image created by this operation.

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:

Indexed RGB – 1, 4, 8 bpp;
RGB – 24 bpp.


Copy Code
HIGEAR hIGear; /* Receives the HIGEAR handle the image created  */
BOOL bPasteAvail;  /* TRUE if a pasteable image is present  */
AT_ERRCOUNT   nErrcount;    /* Holds the returned error count*/
IG_clipboard_paste_available ( &bPasteAvail);
if ( bPasteAvail )
/* Create HIGEAR image from contents of system clipboard:*/
        { nErrcount = IG_clipboard_paste ( &hIGear ); 
        if ( nErrcount )  { ... } /* Process any errors ...*/ }


Prior to calling this function, call IG_clipboard_paste_available_ex() to verify that there is a paste-able image in the clipboard.

Is this page helpful?
Yes No
Thanks for your feedback.