DwtInquireNextPasteFormat(3Dwt)

Name

DwtInquireNextPasteFormat − Returns a specified format name for the next-paste item in the clipboard.

Syntax

int DwtInquireNextPasteFormat(display, window,
                              number, format_name_buf,
                              buffer_len, copied_len)
     Display *display;
     Window window;
     int number;
     char *format_name_buf;
     unsigned long buffer_len;
     unsigned long *copied_len;

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.

numberSpecifies the number of format names to be obtained. If this number n is greater than the number of formats for the data item, DwtInquireNextPasteFormat returns a zero in the copied_len argument.

format_name_buf
Specifies the buffer that receives the format name.

buffer_lenSpecifies the number of bytes in the format name buffer.

copied_lenSpecifies the number of bytes in the string copied to the buffer. If this argument equals zero, there is no nth format for the next-paste item.

Description

The DwtInquireNextPasteFormat function returns a specified format name for the next-paste item in the clipboard. If the name must be truncated, the function returns a warning status.

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.
ClipboardTruncate	The data returned is truncated because the user did not provide a buffer that was large enough to hold the data.
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.