<!-- $XConsortium: ClipbP.sgm /main/10 1996/09/25 10:25:27 cdedoc $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->

<RefEntry Id="CDEMMA.MAN101.rsml.1">
<RefMeta>
<RefEntryTitle>XmClipboardUnlock</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmClipboardUnlock</Function></RefName>
<RefPurpose>A clipboard function that unlocks the clipboard
<IndexTerm>
<Primary>XmClipboardUnlock</Primary>
</IndexTerm><IndexTerm>
<Primary>clipboard functions</Primary>
<Secondary>XmClipboardUnlock</Secondary>
</IndexTerm></RefPurpose>
</RefNameDiv>
<!-- -->
<!-- @OSF_COPYRIGHT@-->
<!-- COPYRIGHT NOTICE-->
<!-- Copyright (c) 1990, 1991, 1992, 1993 Open Software Foundation, Inc.-->
<!-- ALL RIGHTS RESERVED (MOTIF). See the file named COPY.MOTIF.DOC for-->
<!-- the full copyright text.-->
<!-- -->
<!-- HISTORY-->
<!-- -->
<!-- **-->
<!-- **-->
<!-- **  (c) Copyright 1989, 1990, 1992 by Open Software Foundation, Inc.-->
<!-- **      All Rights Reserved.-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988, 1989, by Hewlett-Packard Company-->
<!-- **-->
<!-- **  (c) Copyright 1988 by Massachusetts Institute of Technology-->
<!-- **-->
<!-- **  (c) Copyright 1987, 1988 by Digital Equipment Corporation,-->
<!-- **      Maynard, MA.  All Rights Reserved.-->
<!-- **-->
<!-- **-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/CutPaste.h>
int XmClipboardUnlock (<Replaceable>display, window, remove_all_locks</Replaceable>)
        Display <Replaceable>* display</Replaceable>;
        Window  <Replaceable>window</Replaceable>;
        Boolean <Replaceable>remove_all_locks</Replaceable>;
</FuncSynopsisInfo>
<FuncDef></FuncDef>
<void>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmClipboardUnlock</Function> unlocks the clipboard,
enabling it to be accessed by other applications.
</Para>
<Para>If multiple calls to <Function>XmClipboardLock</Function> have occurred, the same
number of calls to <Function>XmClipboardUnlock</Function> is necessary to unlock the
clipboard, unless <Symbol Role="Variable">remove_all_locks</Symbol> is set to True.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">display</Symbol></Term>
<ListItem>
<Para>Specifies a pointer to the <StructName Role="typedef">Display</StructName> structure that was returned in a
previous call to <Function>XOpenDisplay</Function> or <Function>XtDisplay</Function>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">window</Symbol></Term>
<ListItem>
<Para>Specifies the window ID of a widget that relates the application window to the
clipboard. The widget's window ID can be obtained through
<Function>XtWindow</Function>.
The same application instance should pass the same window ID to each of the
clipboard functions that it calls.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">remove_all_locks</Symbol></Term>
<ListItem>
<Para>When True, indicates that all nested locks should be removed. When False,
indicates that only one level of lock should be removed.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<VariableList>
<VarListEntry>
<Term><Symbol>XmClipboardSuccess</Symbol></Term>
<ListItem>
<Para>The function was successful.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol>XmClipboardFail</Symbol></Term>
<ListItem>
<Para>The function failed because the clipboard was not locked or was locked
by another application.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmClipboardCancelCopy;, &cdeman.XmClipboardCopy;,
&cdeman.XmClipboardEndCopy;, &cdeman.XmClipboardEndRetrieve;,
&cdeman.XmClipboardInquireCount;, &cdeman.XmClipboardInquireFormat;,
&cdeman.XmClipboardInquireLength;, &cdeman.XmClipboardInquirePendingItems;,
&cdeman.XmClipboardLock;, &cdeman.XmClipboardRegisterFormat;,
&cdeman.XmClipboardRetrieve;, &cdeman.XmClipboardStartCopy;,
&cdeman.XmClipboardStartRetrieve;, &cdeman.XmClipboardUndoCopy;,
and &cdeman.XmClipboardWithdrawFormat;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
