DwtInquireNextPasteCount(3Dwt)

Name

DwtInquireNextPasteCount − Returns the number of data item formats available for the next paste item in the clipboard.

Syntax

int DwtInquireNextPasteCount(display, window, count,
                              max_format_name_length)
     Display *display;
     Window window;
     int *count;
     int *max_format_name_length;

Arguments

displaySpecifies a pointer to the Display structure that was returned in a previous call to XOpenDisplay. For information on XOpenDisplay and the Display structure, see the Guide to the Xlib Library: C Language Binding.

windowSpecifies the window ID that relates the application window to the clipboard. The same application instance should pass the same window ID to each clipboard function that it calls.

countReturns the number of data item formats available for the next-paste item in the clipboard. If no formats are available, this argument equals zero. The count includes the formats that were passed by name.

max_format_name_length
Specifies the maximum length of all format names for the next-paste item in the clipboard.

Description

The DwtInquireNextPasteCount function returns the number of data item formats available for the next-paste item in the clipboard. This function also returns the maximum name length for all formats in which the next-paste item is stored.

Return Value

This function returns one of these status return constants:

ClipboardSuccess	The function is successful.
ClipboardLocked	The function failed because the clipboard was locked by another application. The application can continue to call the function with the same parameters until the clipboard is unlocked. Optionally, the application can ask if the user wants to keep trying or to give up on the operation.
ClipboardNoData	Information could not be obtained from an application using the ICCCM clipboard selection mechanism. This return value indicates that the data was not available in the requested format.