<!-- $XConsortium: ClipbN.sgm /main/10 1996/09/25 10:25:13 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.MAN99.rsml.1">
<RefMeta>
<RefEntryTitle>XmClipboardStartRetrieve</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmClipboardStartRetrieve</Function></RefName>
<RefPurpose>A clipboard function that prepares
to retrieve data from the clipboard
<IndexTerm>
<Primary>XmClipboardStartRetrieve</Primary>
</IndexTerm><IndexTerm>
<Primary>clipboard functions</Primary>
<Secondary>XmClipboardStartRetrieve</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 XmClipboardStartRetrieve (<Replaceable>display, window, timestamp</Replaceable>)
        Display <Replaceable>* display</Replaceable>;
        Window  <Replaceable>window</Replaceable>;
        Time    <Replaceable>timestamp</Replaceable>;
</FuncSynopsisInfo>
<FuncDef></FuncDef>
<void>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmClipboardStartRetrieve</Function>
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
<Function>XmClipboardEndRetrieve</Function> is called. Between a call to
<Function>XmClipboardStartRetrieve</Function> and a call to
<Function>XmClipboardEndRetrieve</Function>, multiple calls to
<Function>XmClipboardRetrieve</Function> with the same format name result in data
being incrementally copied from the clipboard until the data in that
format has all been retrieved.
</Para>
<Para>A return value of <Symbol>XmClipboardTruncate</Symbol> from calls to
<Function>XmClipboardRetrieve</Function> indicates that more data remains to be
copied in the given format.
It is recommended that any calls to the <Literal>Inquire</Literal> functions that
the application needs to make to complete the copy from the clipboard
be made between the call to <Function>XmClipboardStartRetrieve</Function> and the
first call to <Function>XmClipboardRetrieve</Function>. This way, the application
does not need to call <Function>XmClipboardLock</Function> and
<Function>XmClipboardUnlock</Function>.
</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">timestamp</Symbol></Term>
<ListItem>
<Para>Specifies the time of the event that triggered the copy.
A valid timestamp must be supplied; it is not sufficient to use
<SystemItem Class="Constant">CurrentTime</SystemItem>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<VariableList>
<VarListEntry>
<Term><Symbol>XmClipboardSuccess</Symbol></Term>
<ListItem>
<Para>The function is successful.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol>XmClipboardLocked</Symbol></Term>
<ListItem>
<Para>The function failed because the clipboard was locked by another
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.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmClipboardEndRetrieve;,
&cdeman.XmClipboardInquireCount;, &cdeman.XmClipboardInquireFormat;,
&cdeman.XmClipboardInquireLength;, &cdeman.XmClipboardInquirePendingItems;,
&cdeman.XmClipboardLock;,
&cdeman.XmClipboardRetrieve;, &cdeman.XmClipboardStartCopy;, and
&cdeman.XmClipboardUnlock;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
