DwtInquireNextPasteLength(3Dwt)

Name

DwtInquireNextPasteLength − Returns the length of the data stored under a specified format name for the next-paste item in the clipboard.

Syntax

int DwtInquireNextPasteLength(display, window,
                              format_name, length)
     Display *display;
     Window window;
     char *format_name;
     unsigned long *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.

format_name
Specifies the name of the format for the next-paste item.

lengthSpecifies the length of the next data item in the specified format. This argument equals zero if no data is found for the specified format, or if there is no item on the clipboard.

Description

The DwtInquireNextPasteLength function returns the length of the data stored under a specified format name for the next paste clipboard data item.

If no data is found for the specified format, or if there is no item on the clipboard, DwtInquireNextPasteLength returns a value of zero.

Note

Any format passed by name is assumed to have the length passed in a call to DwtCopyToClipboard, even though the data has not yet been transferred to the clipboard in that format.

Return Values

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.