<!-- $XConsortium: StrGeB.sgm /main/8 1996/09/08 21:05:07 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.MAN427.rsml.1">
<RefMeta>
<RefEntryTitle>XmStringGetLtoR</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmStringGetLtoR</Function></RefName>
<RefPurpose>A compound string function that searches for a text segment in the input compound string
<IndexTerm>
<Primary>XmStringGetLtoR</Primary>
</IndexTerm><IndexTerm>
<Primary>compound string functions</Primary>
<Secondary>XmStringGetLtoR</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>Boolean <Function>XmStringGetLtoR</Function></FuncDef>
<!--<ParamDef><Replaceable>string, tag, text</Replaceable></ParamDef>-->
<ParamDef>XmString <Parameter>string</Parameter></ParamDef>
<ParamDef>XmStringCharSet <Parameter>tag</Parameter></ParamDef>
<ParamDef>char **<Parameter>text</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>XmStringUnparse</Function>.
<Function>XmStringGetLtoR</Function> returns the first text component in the input
compound string that is tagged with the given tag component. The
returned text is to be a NULL-terminated sequence of single byte characters.
If the function returns True, the function will allocate space
to hold the returned <Emphasis>text</Emphasis>. The application is responsible
for managing the allocated space. The application can recover the
allocated space by calling <Function>XtFree</Function>.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">string</Symbol></Term>
<ListItem>
<Para>Specifies the compound string.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>tag</Emphasis></Term>
<ListItem>
<Para>Specifies the font list element tag associated with the text.
A value of <SystemItem Class="Resource">XmFONTLIST_DEFAULT_TAG</SystemItem> identifies a locale text
segment.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Emphasis>text</Emphasis></Term>
<ListItem>
<Para>Specifies a pointer to a NULL terminated string.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns True if the matching text segment can be found.
On return, <Emphasis>text</Emphasis> will have a NULL terminated
byte
sequence
containing the matched segment.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmStringCreate;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
