DwtCancelCopyFormat(3Dwt)

Name

DwtCancelCopyFormat − Indicates that the application will no longer supply a data item to the clipboard that the application had previously passed by name.

Syntax

int DwtCancelCopyFormat(display, window, data_id)
     Display *display;
     Window window;
     int data_id;

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.

data_idSpecifies an identifying number assigned to the data item that uniquely identifies the data item and the format. This was assigned to the item when it was originally passed by DwtCopyToClipboard.

Description

The DwtCancelCopyFormat function indicates that the application will no longer supply a data item to the clipboard that the application had previously passed by name.

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.