<!-- $XConsortium: TabLstRA.sgm /main/8 1996/09/08 21:09:28 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.MAN462.rsml.1">
<RefMeta>
<RefEntryTitle>XmTabListRemoveTabs</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmTabListRemoveTabs</Function></RefName>
<RefPurpose>A convenience function that removes noncontiguous tabs
<IndexTerm>
<Primary>XmTabListRemoveTabs</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>XmTabList <Function>XmTabListRemoveTabs</Function></FuncDef>
<!--<ParamDef><Replaceable>oldlist, position_list, position_count</Replaceable></ParamDef>-->
<ParamDef>XmTabList <Parameter>oldlist</Parameter></ParamDef>
<ParamDef>Cardinal <Parameter>*position_list</Parameter></ParamDef>
<ParamDef>Cardinal <Parameter>position_count</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmTabListRemoveTabs</Function> removes noncontiguous tabs from a tab list.
The function creates a new tab list by copying the contents of
<Symbol Role="Variable">oldlist</Symbol> and removing all tabs whose corresponding positions
appear in the <Symbol Role="Variable">position_list</Symbol> array.
A warning message
is displayed if a specified position is invalid; for example, if the
value is a number greater than the number of tabs in the tab list.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">tablist</Symbol></Term>
<ListItem>
<Para>Specifies the tab list.
The function deallocates <Symbol Role="Variable">oldlist</Symbol> and the tabs it contains
after extracting the required information.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">position_list</Symbol></Term>
<ListItem>
<Para>Specifies an array of the tab positions to be removed. The position
of the first tab in the list is 0 (zero), the position of the second
tab is 1, and so on.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">position_count</Symbol></Term>
<ListItem>
<Para>Specifies the number of elements in the <Symbol Role="Variable">position_list</Symbol>.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>If <Symbol Role="Variable">oldlist</Symbol> or <Symbol Role="Variable">position_list</Symbol> is NULL, or
<Symbol Role="Variable">position_count</Symbol> is 0 (zero), returns <Symbol Role="Variable">oldlist</Symbol>. Otherwise,
this function returns the new tab list.
The function allocates space to hold the returned tab list.
The application is responsible for managing the allocated space.
The application can recover the allocated space by calling <Function>XmTabListFree</Function>.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmTabList; and
&cdeman.XmTabListFree;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
