1XmClipboardLock(library call)                    XmClipboardLock(library call)
2
3
4

NAME

6       XmClipboardLock — A clipboard function that locks the clipboard
7

SYNOPSIS

9       #include <Xm/CutPaste.h>
10       int XmClipboardLock (display, window)
11               Display * display;
12               Window  window;
13       (void)
14

DESCRIPTION

16       XmClipboardLock  locks the clipboard from access by another application
17       until XmClipboardUnlock is called. All  clipboard  functions  lock  and
18       unlock  the  clipboard  to  prevent  simultaneous access. This function
19       allows the application to keep the clipboard data from changing between
20       calls  to  Inquire  and other clipboard functions. The application does
21       not need to lock the clipboard between  calls  to  XmClipboardStartCopy
22       and  XmClipboardEndCopy or to XmClipboardStartRetrieve and XmClipboard‐
23       EndRetrieve.
24
25       If the clipboard is already locked by another application, XmClipboard‐
26       Lock  returns  an  error status. Multiple calls to this function by the
27       same application increase the lock level.
28
29       display   Specifies  a  pointer  to  the  Display  structure  that  was
30                 returned in a previous call to XOpenDisplay or XtDisplay.
31
32       window    Specifies the window ID of a widget that relates the applica‐
33                 tion window to the clipboard. The widget's window ID  can  be
34                 obtained  through  XtWindow.   The  same application instance
35                 should pass the same window ID to each of the clipboard func‐
36                 tions that it calls.
37

RETURN

39       XmClipboardSuccess
40                 The function was successful.
41
42       XmClipboardLocked
43                 The  function  failed  because  the  clipboard  was locked by
44                 another application. The application can continue to call the
45                 function  again  with the same parameters until the lock goes
46                 away. This gives the application the opportunity  to  ask  if
47                 the user wants to keep trying or to give up on the operation.
48

50       XmClipboardEndCopy(3),   XmClipboardEndRetrieve(3),   XmClipboardStart‐
51       Copy(3), XmClipboardStartRetrieve(3), and XmClipboardUnlock(3).
52
53
54
55                                                 XmClipboardLock(library call)
Impressum