<!-- $XConsortium: StrCoA.sgm /main/9 1996/09/08 21:03:04 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.MAN406.rsml.1">
<RefMeta>
<RefEntryTitle>XmStringCompare</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmStringCompare</Function></RefName>
<RefPurpose>A compound string function that compares two strings
<IndexTerm>
<Primary>XmStringCompare</Primary>
</IndexTerm><IndexTerm>
<Primary>compound string functions</Primary>
<Secondary>XmStringCompare</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>XmStringCompare</Function></FuncDef>
<!--<ParamDef><Replaceable>s1, s2</Replaceable></ParamDef>-->
<ParamDef>XmString <Parameter>s1</Parameter></ParamDef>
<ParamDef>XmString <Parameter>s2</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmStringCompare</Function> returns a Boolean value indicating the results of a
semantically equivalent comparison of two compound strings.
</Para>
<Para>Semantically equivalent means that the strings have the
same text components, font list element tags, directions,
and separators. In general, if two compound strings are created
with the same (<StructName Role="typedef">char *</StructName>) string using <Function>XmStringCreateLocalized</Function> in
the same language environment, the compound strings compare as equal.
If two compound strings are created with the same text and tag argument
using <Function>XmStringCreate</Function>, the strings compare as equal.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">s1</Symbol></Term>
<ListItem>
<Para>Specifies a compound string to be compared with <Symbol Role="Variable">s2</Symbol>
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">s2</Symbol></Term>
<ListItem>
<Para>Specifies a compound string to be compared with <Symbol Role="Variable">s1</Symbol>
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns True if two compound strings are equivalent.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmStringCreate; and
&cdeman.XmStringCreateLocalized;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
