bad format for help
[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)$</DATE>
11
12   <SHORT_DESCRIPTION name="strcmpi">compare character strings (case
13   independent)</SHORT_DESCRIPTION>
14
15   <CALLING_SEQUENCE>
16     <CALLING_SEQUENCE_ITEM>res =
17     strcmpi(string_one,string_two)</CALLING_SEQUENCE_ITEM>
18   </CALLING_SEQUENCE>
19
20   <PARAM>
21     <PARAM_INDENT>
22       <PARAM_ITEM>
23         <PARAM_NAME>string_one</PARAM_NAME>
24
25         <PARAM_DESCRIPTION>
26           <SP>: string or matrix of strings</SP>
27         </PARAM_DESCRIPTION>
28       </PARAM_ITEM>
29
30       <PARAM_ITEM>
31         <PARAM_NAME>string_two</PARAM_NAME>
32
33         <PARAM_DESCRIPTION>
34           <SP>: string or matrix of strings</SP>
35         </PARAM_DESCRIPTION>
36       </PARAM_ITEM>
37
38       <PARAM_ITEM>
39         <PARAM_NAME>res</PARAM_NAME>
40
41         <PARAM_DESCRIPTION>
42           <SP>: matrix.</SP>
43         </PARAM_DESCRIPTION>
44       </PARAM_ITEM>
45     </PARAM_INDENT>
46   </PARAM>
47
48   <DESCRIPTION>
49     <P><VERB>res = strcmpi(string_one,string_two)</VERB> returns an integral
50     value indicating the relationship between the strings.</P>
51
52     <P>A value greater than zero indicates that the first character that does
53     not match has a greater value in <VERB>string_one</VERB> than in
54     <VERB>string_two</VERB></P>
55
56     <P>And a value less than zero indicates the opposite.</P>
57   </DESCRIPTION>
58
59   <EXAMPLE><![CDATA[
60
61 TXT1 = ['scilab','SciLab';'Strcmp','STRcmp'];
62 TXT2 = ['ScIlAb','sciLab';'sTrCmP','StrCMP'];
63 strcmpi(TXT1,TXT2)
64 strcmpi(TXT1,'scilab')
65  
66   ]]></EXAMPLE>
67
68   <SEE_ALSO>
69     <SEE_ALSO_ITEM>
70       <LINK>strcat</LINK>
71     </SEE_ALSO_ITEM>
72
73     <SEE_ALSO_ITEM>
74       <LINK>strcmp</LINK>
75     </SEE_ALSO_ITEM>
76   </SEE_ALSO>
77 </MAN>