<!-- $XConsortium: StrByA.sgm /main/9 1996/09/08 21:02:56 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.MAN404.rsml.1">
<RefMeta>
<RefEntryTitle>XmStringByteCompare</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmStringByteCompare</Function></RefName>
<RefPurpose>A compound string function that indicates the results of a byte-by-byte comparison
<IndexTerm>
<Primary>XmStringByteCompare</Primary>
</IndexTerm><IndexTerm>
<Primary>compound string functions</Primary>
<Secondary>XmStringByteCompare</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-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/Xm.h>
</FuncSynopsisInfo>
<FuncDef>Boolean <Function>XmStringByteCompare</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>This function is obsolete and exists for compatibility with previous
releases.
<Function>XmStringByteCompare</Function>
returns a Boolean indicating the results of a byte-by-byte
comparison of two compound strings.
</Para>
<Para>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 (<Literal>char&ensp;*</Literal>) string and
the same font list element tag set other than <SystemItem Class="Resource">XmFONTLIST_DEFAULT_TAG</SystemItem>
using <Function>XmStringCreate</Function>, the strings compare as
equal.
</Para>
<Para>In some cases, once a compound string
is put into a widget, that string is converted into an internal form to
allow faster processing. Part of the conversion process strips out
unnecessary or redundant information. If an application then does an
<Function>XtGetValues</Function> to retrieve a compound string from a widget (specifically,
Label and all of its subclasses), it is not guaranteed that the compound
string returned is byte-for-byte the same as the string given to
the widget originally.
</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 identical byte-by-byte.
</Para>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmStringCreate; and
&cdeman.XmStringCreateLocalized;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
