removes occurence of str2, str3 ... in order to provide better documentation
[scilab.git] / scilab / modules / string / help / en_US / strcmpi.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE MAN SYSTEM "../../../../modules/helptools/help.dtd">
3 <MAN>
4   <LANGUAGE>eng</LANGUAGE>
5
6   <TITLE>strcmpi</TITLE>
7
8   <TYPE>Scilab Function</TYPE>
9
10   <DATE>$LastChangedDate: 2006-08-08 16:57:13 +0200 (Tue, 08 Aug 2006)
11   $</DATE>
12
13   <SHORT_DESCRIPTION name="strcmpi">compare character strings (case
14   independent)</SHORT_DESCRIPTION>
15
16   <CALLING_SEQUENCE>
17     <CALLING_SEQUENCE_ITEM>res =
18     strcmpi(string_one,string_two)</CALLING_SEQUENCE_ITEM>
19   </CALLING_SEQUENCE>
20
21   <PARAM>
22     <PARAM_INDENT>
23       <PARAM_ITEM>
24         <PARAM_NAME>string_one</PARAM_NAME>
25
26         <PARAM_DESCRIPTION>
27           <SP>: string or matrix of strings</SP>
28         </PARAM_DESCRIPTION>
29       </PARAM_ITEM>
30
31       <PARAM_ITEM>
32         <PARAM_NAME>string_two</PARAM_NAME>
33
34         <PARAM_DESCRIPTION>
35           <SP>: string or matrix of strings</SP>
36         </PARAM_DESCRIPTION>
37       </PARAM_ITEM>
38
39       <PARAM_ITEM>
40         <PARAM_NAME>res</PARAM_NAME>
41
42         <PARAM_DESCRIPTION>
43           <SP>: matrix.</SP>
44         </PARAM_DESCRIPTION>
45       </PARAM_ITEM>
46     </PARAM_INDENT>
47   </PARAM>
48
49   <DESCRIPTION>
50     <P><VERB>res = strcmpi(string_one,string_two)</VERB> returns an integral
51     value indicating the relationship between the strings.</P>
52
53     <P>A value greater than zero indicates that the first character that does
54     not match has a greater value in <VERB>string_one</VERB> than in
55     <VERB>string_two</VERB></P>
56
57     <P>And a value less than zero indicates the opposite.</P>
58   </DESCRIPTION>
59
60   <EXAMPLE><![CDATA[
61
62 TXT1 = ['scilab','SciLab';'Strcmp','STRcmp'];
63 TXT2 = ['ScIlAb','sciLab';'sTrCmP','StrCMP'];
64 strcmpi(TXT1,TXT2)
65 strcmpi(TXT1,'scilab')
66  
67   ]]></EXAMPLE>
68
69   <SEE_ALSO>
70     <SEE_ALSO_ITEM>
71       <LINK>strcat</LINK>
72     </SEE_ALSO_ITEM>
73
74     <SEE_ALSO_ITEM>
75       <LINK>strcmp</LINK>
76     </SEE_ALSO_ITEM>
77   </SEE_ALSO>
78 </MAN>