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