132d63549d5697e784539b9b8fae31cc66a872a5
[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-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" version="5.0-subset Scilab" xml:lang="en" xml:id="strcmpi">
14   <info>
15     <pubdate>$LastChangedDate: 2006-08-08 16:57:13 +0200 (Tue, 08 Aug 2006)$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>strcmpi</refname>
19     <refpurpose>compare character strings (case
20       independent)
21     </refpurpose>
22   </refnamediv>
23   <refsynopsisdiv>
24     <title>Calling Sequence</title>
25     <synopsis>res = strcmpi(string_one,string_two)</synopsis>
26   </refsynopsisdiv>
27   <refsection>
28     <title>Arguments</title>
29     <variablelist>
30       <varlistentry>
31         <term>string_one</term>
32         <listitem>
33           <para>A character string or matrix of character strings</para>
34         </listitem>
35       </varlistentry>
36       <varlistentry>
37         <term>string_two</term>
38         <listitem>
39           <para>A character string or matrix of character strings</para>
40         </listitem>
41       </varlistentry>
42       <varlistentry>
43         <term>res</term>
44         <listitem>
45           <para>matrix.</para>
46         </listitem>
47       </varlistentry>
48     </variablelist>
49   </refsection>
50   <refsection>
51     <title>Description</title>
52     <para>
53       <literal>res = strcmpi(string_one,string_two)</literal> returns an integral
54       value indicating the relationship between the strings.
55     </para>
56     <para>A value greater than zero indicates that the first character that does
57       not match has a greater value in <literal>string_one</literal> than in
58       <literal>string_two</literal>
59     </para>
60     <para>And a value less than zero indicates the opposite.</para>
61   </refsection>
62   <refsection>
63     <title>Examples</title>
64     <programlisting role="example"><![CDATA[ 
65 TXT1 = ['scilab','SciLab';'Strcmp','STRcmp'];
66 TXT2 = ['ScIlAb','sciLab';'sTrCmP','StrCMP'];
67 strcmpi(TXT1,TXT2)
68 strcmpi(TXT1,'scilab')
69  ]]></programlisting>
70   </refsection>
71   <refsection role="see also">
72     <title>See Also</title>
73     <simplelist type="inline">
74       <member>
75         <link linkend="strcat">strcat</link>
76       </member>
77       <member>
78         <link linkend="strcmp">strcmp</link>
79       </member>
80     </simplelist>
81   </refsection>
82 </refentry>