<!-- $XConsortium: StrPut.sgm /main/8 1996/09/08 21:06: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.MAN442.rsml.1">
<RefMeta>
<RefEntryTitle>XmStringPutRendition</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmStringPutRendition</Function></RefName>
<RefPurpose>A convenience function that places renditions around strings
<IndexTerm>
<Primary>XmStringPutRendition</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>XmString <Function>XmStringPutRendition</Function></FuncDef>
<!--<ParamDef><Replaceable>string, rendition</Replaceable></ParamDef>-->
<ParamDef>XmString <Parameter>string</Parameter></ParamDef>
<ParamDef>XmStringTag <Parameter>rendition</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmStringPutRendition</Function> places matching
<SystemItem Class="Constant">Xm_STRING_COMPONENT_RENDITION_BEGIN</SystemItem> and
<SystemItem Class="Constant">XmSTRING_COMPONENT_RENDITION_END</SystemItem> components containing
<Symbol Role="Variable">rendition</Symbol> around
<Symbol Role="Variable">string</Symbol>. The original string is preserved.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">string</Symbol></Term>
<ListItem>
<Para>Specifies the compound string to which begin and end rendition
components should be added.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">rendition</Symbol></Term>
<ListItem>
<Para>Specifies the rendition tag to be used in an
<SystemItem Class="Constant">XmSTRING_COMPONENT_RENDITION_BEGIN</SystemItem> component which will begin
the returned string and in an <SystemItem Class="Constant">XmSTRING_COMPONENT_RENDITION_END</SystemItem>
component which will end it.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns a new compound string.
The function allocates space to hold this returned compound string.
When the application no longer needs the returned compound string,
the application should call <Function>XmStringFree</Function>.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmString;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
