XmClipboardStartRetrieve - A clipboard function that starts a copy from the clipboard
#include <Xm/Xm.h> #include <Xm/CutPaste.h> int XmClipboardStartRetrieve (display, window, timestamp) Display * display; Window window; Time timestamp;
XmClipboardStartRetrieve tells the clipboard routines that the application is ready to start copying an item from the clipboard. The clipboard is locked by this routine and stays locked until XmClipboardEndRetrieve 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 copied.
The return value ClipboardTruncate 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 application needs to make to effect the copy from the clipboard be made between the call to XmClipboardStartRetrieve and the first call to XmClipboardRetrieve. That way, the application does not need to call XmClipboardLock and XmClipboardUnlock.
XmClipboardEndRetrieve(3X), XmClipboardInquireCount(3X), XmClipboardInquireFormat(3X), XmClipboardInquireLength(3X), XmClipboardInquirePendingItems(3X), XmClipboardLock(3X), XmClipboardRetrieve(3X), XmClipboardStartCopy(3X), and XmClipboardUnlock(3X).