<!-- $XConsortium: StrSeg.sgm /main/8 1996/09/08 21:07:02 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.MAN443.rsml.1">
<RefMeta>
<RefEntryTitle>XmStringSegmentCreate</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmStringSegmentCreate</Function></RefName>
<RefPurpose>A compound string function that creates a compound string
<IndexTerm>
<Primary>XmStringSegmentCreate</Primary>
</IndexTerm><IndexTerm>
<Primary>compound string functions</Primary>
<Secondary>XmStringSegmentCreate</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/Xm.h>
</FuncSynopsisInfo>
<FuncDef>XmString <Function>XmStringSegmentCreate</Function></FuncDef>
<!--<ParamDef><Replaceable>text, tag, direction, separator</Replaceable></ParamDef>-->
<ParamDef>char <Parameter>* text</Parameter></ParamDef>
<ParamDef>XmStringTag <Parameter>tag</Parameter></ParamDef>
<ParamDef>XmStringDirection <Parameter>direction</Parameter></ParamDef>
<ParamDef>Boolean <Parameter>separator</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>This function is obsolete and exists for compatibility with previous
releases. It can be replaced by using a combination of
<Function>XmStringComponentCreate</Function> and <Function>XmStringConcat</Function>.
<Function>XmStringSegmentCreate</Function> is a high-level function that assembles a compound
string consisting of a font list element tag, a direction component,
a text component, and an optional separator component.
</Para>
<Para>The function allocates space for the returned compound string.
The application is responsible for managing the allocated space.
The application can recover the allocated space by calling <Function>XmStringFree</Function>.
</Para>
<VariableList>
<VarListEntry>
<Term><Emphasis>text</Emphasis></Term>
<ListItem>
<Para>Specifies a NULL-terminated string to be used as the text component of
the compound string.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>tag</Emphasis></Term>
<ListItem>
<Para>Specifies the tag component to be associated with the text.
The value <SystemItem Class="Resource">XmFONTLIST_DEFAULT_TAG</SystemItem> is for compatibility with
previous releases.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>direction</Emphasis></Term>
<ListItem>
<Para>Specifies the direction of the text.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">separator</Symbol></Term>
<ListItem>
<Para>A value of False means
the compound string does not
have a separator at the end. A value of True, means a separator immediately
follows the text component.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns a new compound string.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmStringCreate;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
