<!-- $XConsortium: StrCrC.sgm /main/8 1996/09/08 21:03: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.MAN414.rsml.1">
<RefMeta>
<RefEntryTitle>XmStringCreateLtoR</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmStringCreateLtoR</Function></RefName>
<RefPurpose>A compound string function that creates a compound string
<IndexTerm>
<Primary>XmStringCreateLtoR</Primary>
</IndexTerm><IndexTerm>
<Primary>compound string functions</Primary>
<Secondary>XmStringCreateLtoR</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>XmStringCreateLtoR</Function></FuncDef>
<!--<ParamDef><Replaceable>text, tag</Replaceable></ParamDef>-->
<ParamDef>char *<Parameter>text</Parameter></ParamDef>
<ParamDef>char *<Parameter>tag</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para>This function is obsolete and exists for compatibility with previous
releases. It is replaced by <Function>XmStringGenerate</Function>.
<Function>XmStringCreateLtoR</Function> creates a compound
string with two components: text and a
tag component.
This function
scans
for <Literal>&bsol;n</Literal>
characters in the text. When one is found, the text up to that point
is put into a segment followed by a separator component. No final
separator component is appended to the end of the compound string.
The direction
component
defaults to left-to-right.
This function assumes that the encoding is single
byte
rather than
multibyte.
</Para>
<Para>The function will allocate space to hold 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 given
text. The value <SystemItem Class="Resource">XmFONTLIST_DEFAULT_TAG</SystemItem> is retained for
compatibility with previous releases.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns a new compound string.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmStringCreate;
and &cdeman.XmStringGenerate;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
