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_available
In This Topic
    IG_clipboard_paste_available
    In This Topic

    This function retrieves whether there is compatible data available in the clipboard.

    Declaration:

     
    Copy Code
    AT_ERRCOUNT ACCUAPI IG_clipboard_paste_available(
          LPAT_BOOL lpPasteStatus
    );
    

    Arguments:

    Name Type Description
    lpPasteStatus LPAT_BOOL Pointer indicating where to return the boolean value that indicates whether clipboard data is available.

    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.

    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_available_ex