Add role in the 'see also' section in the help page
[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)</refpurpose>
21   </refnamediv>
22   <refsynopsisdiv>
23     <title>Calling Sequence</title>
24     <synopsis>res = strcmpi(string_one,string_two)</synopsis>
25   </refsynopsisdiv>
26   <refsection>
27     <title>Arguments</title>
28     <variablelist>
29       <varlistentry>
30         <term>string_one</term>
31         <listitem>
32           <para>A character string or matrix of character strings</para>
33         </listitem>
34       </varlistentry>
35       <varlistentry>
36         <term>string_two</term>
37         <listitem>
38           <para>A character string or matrix of character strings</para>
39         </listitem>
40       </varlistentry>
41       <varlistentry>
42         <term>res</term>
43         <listitem>
44           <para>matrix.</para>
45         </listitem>
46       </varlistentry>
47     </variablelist>
48   </refsection>
49   <refsection>
50     <title>Description</title>
51     <para><literal>res = strcmpi(string_one,string_two)</literal> returns an integral
52     value indicating the relationship between the strings.</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></para>
56     <para>And a value less than zero indicates the opposite.</para>
57   </refsection>
58   <refsection>
59     <title>Examples</title>
60     <programlisting role="example"><![CDATA[ 
61 TXT1 = ['scilab','SciLab';'Strcmp','STRcmp'];
62 TXT2 = ['ScIlAb','sciLab';'sTrCmP','StrCMP'];
63 strcmpi(TXT1,TXT2)
64 strcmpi(TXT1,'scilab')
65  ]]></programlisting>
66   </refsection>
67   <refsection role="see also">
68 <title>See Also</title>
69     <simplelist type="inline">
70       <member>
71         <link linkend="strcat">strcat</link>
72       </member>
73       <member>
74         <link linkend="strcmp">strcmp</link>
75       </member>
76     </simplelist>
77   </refsection>
78 </refentry>