FreeBSD Manual Pages
XmClipboar...rtRetrieve(3) Library Functions Manual XmClipboar...rtRetrieve(3) NAME XmClipboardStartRetrieve -- A clipboard function that prepares to re- trieve data from the clipboard SYNOPSIS #include <Xm/CutPaste.h> int XmClipboardStartRetrieve (display, window, timestamp) Display * display; Window window; Time timestamp; (void) DESCRIPTION XmClipboardStartRetrieve tells the clipboard routines that the applica- tion is ready to start copying an item from the clipboard. The clip- board is locked by this routine and stays locked until XmClipboardEn- dRetrieve is called. Between a call to XmClipboardStartRetrieve and a call to XmClipboardEndRetrieve, multiple calls to XmClipboardRetrieve with the same format name result in data being incrementally copied from the clipboard until the data in that format has all been re- trieved. A return value of XmClipboardTruncate from calls to XmClipboardRetrieve indicates that more data remains to be copied in the given format. It is recommended that any calls to the Inquire functions that the appli- cation needs to make to complete the copy from the clipboard be made between the call to XmClipboardStartRetrieve and the first call to Xm- ClipboardRetrieve. This way, the application does not need to call Xm- ClipboardLock and XmClipboardUnlock. display Specifies a pointer to the Display structure that was re- turned in a previous call to XOpenDisplay or XtDisplay. window Specifies the window ID of a widget that relates the applica- tion window to the clipboard. The widget's window ID can be obtained through XtWindow. The same application instance should pass the same window ID to each of the clipboard func- tions that it calls. timestamp Specifies the time of the event that triggered the copy. A valid timestamp must be supplied; it is not sufficient to use CurrentTime. RETURN XmClipboardSuccess The function is successful. XmClipboardLocked The function failed because the clipboard was locked by an- other application. The application can continue to call the function again with the same parameters until the lock goes away. This gives the application the opportunity to ask if the user wants to keep trying or to give up on the operation. RELATED XmClipboardEndRetrieve(3), XmClipboardInquireCount(3), XmClipboard- InquireFormat(3), XmClipboardInquireLength(3), XmClipboard- InquirePendingItems(3), XmClipboardLock(3), XmClipboardRetrieve(3), Xm- ClipboardStartCopy(3), and XmClipboardUnlock(3). XmClipboar...rtRetrieve(3)
NAME | SYNOPSIS | DESCRIPTION | RETURN | RELATED
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=XmClipboardStartRetrieve&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>