<!-- $XConsortium: LstGetMa.sgm /main/7 1996/08/30 15:42:31 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.MAN297.rsml.1">
<RefMeta>
<RefEntryTitle>XmListGetMatchPos</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmListGetMatchPos</Function></RefName>
<RefPurpose>A List function that returns all instances of an item in the list
<IndexTerm>
<Primary>XmListGetMatchPos</Primary>
</IndexTerm><IndexTerm>
<Primary>List functions</Primary>
<Secondary>XmListGetMatchPos</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-->
<!-- **-->
<!-- **-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/List.h>
</FuncSynopsisInfo>
<FuncDef>Boolean <Function>XmListGetMatchPos</Function></FuncDef>
<!--<ParamDef><Replaceable>widget, item, position_list, position_count</Replaceable></ParamDef>-->
<ParamDef>Widget <Parameter>widget</Parameter></ParamDef>
<ParamDef>XmString <Parameter>item</Parameter></ParamDef>
<ParamDef>int **<Parameter>position_list</Parameter></ParamDef>
<ParamDef>int *<Parameter>position_count</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmListGetMatchPos</Function> is a Boolean function that returns an array of
positions where a specified item is found in a List.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">widget</Symbol></Term>
<ListItem>
<Para>Specifies the ID of the List widget.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">item</Symbol></Term>
<ListItem>
<Para>Specifies the item to search for.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">position_list</Symbol></Term>
<ListItem>
<Para>Returns an array of positions at which the item occurs in the List.
The position of the first item in the list is 1; the position of the
second item is 2; and so on.
When the return value is True, <Function>XmListGetMatchPos</Function> allocates
memory for this array.
The caller is responsible for freeing this memory.
The caller can recover the allocated memory by calling <Function>XtFree</Function>.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">position_count</Symbol></Term>
<ListItem>
<Para>Returns the number of elements in the <Symbol Role="Variable">position_list</Symbol>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
<Para>For a complete definition of List and its associated resources, see
&cdeman.XmList;.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns True if the specified item is present in the list, and
False if it is not.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmList;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
