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