Get ride of the useless pubdate tag.
[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   <refnamediv>
15     <refname>strcmpi</refname>
16     <refpurpose>compare character strings (case
17       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>A character string or matrix of character strings</para>
31         </listitem>
32       </varlistentry>
33       <varlistentry>
34         <term>string_two</term>
35         <listitem>
36           <para>A character string or matrix of character strings</para>
37         </listitem>
38       </varlistentry>
39       <varlistentry>
40         <term>res</term>
41         <listitem>
42           <para>matrix.</para>
43         </listitem>
44       </varlistentry>
45     </variablelist>
46   </refsection>
47   <refsection>
48     <title>Description</title>
49     <para>
50       <literal>res = strcmpi(string_one,string_two)</literal> returns an integral
51       value indicating the relationship between the strings.
52     </para>
53     <para>A value greater than zero indicates that the first character that does
54       not match has a greater value in <literal>string_one</literal> than in
55       <literal>string_two</literal>
56     </para>
57     <para>And a value less than zero indicates the opposite.</para>
58   </refsection>
59   <refsection>
60     <title>Examples</title>
61     <programlisting role="example"><![CDATA[ 
62 TXT1 = ['scilab','SciLab';'Strcmp','STRcmp'];
63 TXT2 = ['ScIlAb','sciLab';'sTrCmP','StrCMP'];
64 strcmpi(TXT1,TXT2)
65 strcmpi(TXT1,'scilab')
66  ]]></programlisting>
67   </refsection>
68   <refsection role="see also">
69     <title>See Also</title>
70     <simplelist type="inline">
71       <member>
72         <link linkend="strcat">strcat</link>
73       </member>
74       <member>
75         <link linkend="strcmp">strcmp</link>
76       </member>
77     </simplelist>
78   </refsection>
79 </refentry>