<!-- $XConsortium: TabLstGe.sgm /main/9 1996/09/08 21:09:12 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.MAN460.rsml.1">
<RefMeta>
<RefEntryTitle>XmTabListGetTab</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmTabListGetTab</Function></RefName>
<RefPurpose>A convenience function that returns a copy of a tab
<IndexTerm>
<Primary>XmTabListGetTab</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-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/Xm.h>
</FuncSynopsisInfo>
<FuncDef>XmTab <Function>XmTabListGetTab</Function></FuncDef>
<!--<ParamDef><Replaceable>tablist, position</Replaceable></ParamDef>-->
<ParamDef>XmTabList <Parameter>tablist</Parameter></ParamDef>
<ParamDef>Cardinal <Parameter>position</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmTabListGetTab</Function> returns a copy of the tab that is located at the
specified position in the tab list.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">tablist</Symbol></Term>
<ListItem>
<Para>Specifies the tab list.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">position</Symbol></Term>
<ListItem>
<Para>Specifies the position of the tab to be returned. A value of 0 (zero)
returns the first tab in the tab list, a value of 1 returns the second
tab, and so on.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns a copy of the tab that is located at the specified position in
the tab list. If <Symbol Role="Variable">position</Symbol> is greater than or equal to the
number of tabs in the tab list, this function returns NULL.
The application is responsible for managing the space allocted by
the returned tab copy. The application can recover this allocated
space by calling <Function>XmTabFree</Function>.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmTabFree; and
&cdeman.XmTabList;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
