<!-- $XConsortium: DropSitQ.sgm /main/8 1996/09/08 20:41:18 rws $ -->
<!-- (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.MAN214.rsml.1">
<RefMeta>
<RefEntryTitle>XmDropSiteQueryStackingOrder</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmDropSiteQueryStackingOrder</Function></RefName>
<RefPurpose>A Drag and Drop function that
returns the parent, a list of children, and the number of children
for a specified widget
<IndexTerm>
<Primary>XmDropSiteQueryStacking\\%Order</Primary>
</IndexTerm><IndexTerm>
<Primary>Drag and Drop functions</Primary>
<Secondary>XmDropSiteQueryStacking\\%Order</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 1987, 1988 by Digital Equipment Corporation,-->
<!-- **      Maynard, MA.  All Rights Reserved.-->
<!-- **-->
<!-- **-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/DragDrop.h>
</FuncSynopsisInfo>
<FuncDef>Status <Function>XmDropSiteQueryStackingOrder</Function></FuncDef>
<!--<ParamDef><Replaceable>widget, parent_return, child_returns,
num_child_returns</Replaceable></ParamDef>-->
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
<ParamDef>Widget *<Parameter>parent_return</Parameter></ParamDef>
<ParamDef>Widget **<Parameter>child_returns</Parameter></ParamDef>
<ParamDef>Cardinal *<Parameter>num_child_returns</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmDropSiteQueryStackingOrder</Function> obtains the parent, a list of
children registered as drop sites, and the number of children registered
as drop sites for a given widget. The children are listed in current
stacking order, from bottom-most (first child) to the top-most (last
child).
<!-- Delete this next line after the AES becomes unfrozen.-->This function allocates memory for the returned data that
must be freed by calling <Function>XtFree</Function>.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">widget</Symbol></Term>
<ListItem>
<Para>Specifies the widget ID. For this widget, you obtain the list
of its children, its parent, and the number of children.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">parent_return</Symbol></Term>
<ListItem>
<Para>Returns the widget ID of the drop site parent of the
specified widget.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">child_returns</Symbol></Term>
<ListItem>
<Para>Returns a pointer to the list of drop site children associated with
the specified widget.
The function allocates memory to hold the list.
The application is responsible for managing the allocated space.
The application can recover the allocated space by calling <Function>XtFree</Function>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">num_child_returns</Symbol></Term>
<ListItem>
<Para>Returns the number of drop site children for the specified widget.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>For a complete definition of DropSite and its associated resources,
see &cdeman.XmDropSite;.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns 0 (zero) if the routine fails; returns a nonzero
value if it succeeds.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmDropSite; and
&cdeman.XmDropSiteConfigureStackingOrder;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
