<!-- $XConsortium: ContainE.sgm /main/8 1996/09/08 20:31:53 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.MAN114.rsml.1">
<RefMeta>
<RefEntryTitle>XmContainerGetItemChildren</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmContainerGetItemChildren</Function></RefName>
<RefPurpose>Container widget function to find
all children of an item
<IndexTerm>
<Primary>XmContainerGetItemChildren</Primary>
</IndexTerm><IndexTerm>
<Primary>XmContainer</Primary>
</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 1993 by International Business Machines Corporation-->
<!-- **      All Rights Reserved.-->
<!-- **-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/Container.h>
</FuncSynopsisInfo>
<FuncDef>int <Function>XmContainerGetItemChildren</Function></FuncDef>
<!--<ParamDef><Replaceable>container, item, item_children</Replaceable></ParamDef>-->
<ParamDef>Widget <Parameter>container</Parameter></ParamDef>
<ParamDef>Widget <Parameter>item</Parameter></ParamDef>
<ParamDef>WidgetList * <Parameter>item_children</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmContainerGetItemChildren</Function> allocates a WidgetList and stores within
it the widget IDs of all widgets that have <Symbol Role="Variable">item</Symbol> specified as the value
of their <SystemItem Class="Resource">XmNentryParent</SystemItem> resource.
The application programmer is responsible for freeing the allocated
WidgetList using XtFree.
The number of widget IDs returned
in <Symbol Role="Variable">item_children</Symbol> is returned by the function. If no widgets specify
<Symbol Role="Variable">item</Symbol> as the value of their <SystemItem Class="Resource">XmNentryParent</SystemItem> resource,
the function returns zero and <Symbol Role="Variable">item_children</Symbol> is left unchanged.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">container</Symbol></Term>
<ListItem>
<Para>Specifies the Container widget ID.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">item</Symbol></Term>
<ListItem>
<Para>Specifies a widgetID within <Symbol Role="Variable">container</Symbol>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">item_children</Symbol></Term>
<ListItem>
<Para>Returned array of Widgets.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>For a complete definition of Container and its associated resources, see
&cdeman.XmContainer;.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>This function returns a count of all widgets that have <Symbol Role="Variable">item</Symbol>
specified as the value of their <SystemItem Class="Resource">XmNentryParent</SystemItem> resource.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmContainer;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
