1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) INRIA -
*
* This file must be used under the terms of the CeCILL.
* This source file is licensed as described in the file COPYING, which
* you should have received as part of this distribution. The terms
* are also available at
* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
*
-->
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="strcmp" xml:lang="en">
<refnamediv>
<refname>strcmp</refname>
<refpurpose>compare character strings</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>res = strcmp(string_one, string_two, ['i'])</synopsis>
</refsynopsisdiv>
<refsection>
<title>Arguments</title>
<variablelist>
<varlistentry>
<term>string_one</term>
<listitem>
<para>
a character string or matrix of character strings.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>string_two</term>
<listitem>
<para>
a character string or matrix of character strings.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>'i'</term>
<listitem>
<para>
an optional parameter to do <function>strcmpi</function>
(case independent), default value is <literal>'s'</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>res</term>
<listitem>
<para>a matrix of integers.</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>Description</title>
<para>
<code>res = strcmp(string_one, string_two)</code> (or
<code>res = strcmp(string_one, string_two, 's')</code>) returns an
integral value indicating the relationship between the strings.
</para>
<para>
The value greater than zero indicates that the first character that
does not match has a greater value in <varname>string_one</varname>
than in <varname>string_two</varname> and the value less than zero
indicates the opposite (lexicographical order).
</para>
<para>
The value equal zero indicates that <varname>string_one</varname>
and <varname>string_two</varname> are equal.
</para>
<para>
<code>res = strcmp(string_one, string_two, 'i')</code> returns
<literal>0</literal> if <varname>string_one</varname> is equal to
<varname>string_two</varname> (case independently) and
<literal>1</literal> indicates the opposite.
</para>
</refsection>
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
TXT1 = ['scilab','SciLab';'Strcmp','STRcmp'];
TXT2 = ['ScIlAb','sciLab';'sTrCmP','StrCMP'];
strcmp(TXT1,TXT2)
strcmp(TXT1,'scilab')
strcmp(TXT1,'SciLab')
strcmp(TXT1,TXT2,'i')
strcmp(TXT1,TXT2,'s')
]]></programlisting>
</refsection>
<refsection role="see also">
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="strcat">strcat</link>
</member>
<member>
<link linkend="strcmpi">strcmpi</link>
</member>
</simplelist>
</refsection>
</refentry>
|
