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