bad format for help
[scilab.git] / scilab / modules / string / help / en_US / strcmp.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>strcmp</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="strcmp">compare character
13   strings</SHORT_DESCRIPTION>
14
15   <CALLING_SEQUENCE>
16     <CALLING_SEQUENCE_ITEM>res =
17     strcmp(string_one,string_two,[,'i'])</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>'i'</PARAM_NAME>
40
41         <PARAM_DESCRIPTION>
42           <SP>: parameter to do stricmp, default value is 's'</SP>
43         </PARAM_DESCRIPTION>
44       </PARAM_ITEM>
45
46       <PARAM_ITEM>
47         <PARAM_NAME>res</PARAM_NAME>
48
49         <PARAM_DESCRIPTION>
50           <SP>: matrix.</SP>
51         </PARAM_DESCRIPTION>
52       </PARAM_ITEM>
53     </PARAM_INDENT>
54   </PARAM>
55
56   <DESCRIPTION>
57     <P><VERB>res = strcmp(string_one,string_two)</VERB> returns an integral
58     value indicating the relationship between the strings.</P>
59
60     <P>A value greater than zero indicates that the first character that does
61     not match has a greater value in <VERB>string_one</VERB> than in
62     <VERB>string_two</VERB></P>
63
64     <P>And a value less than zero indicates the opposite.</P>
65   </DESCRIPTION>
66
67   <EXAMPLE><![CDATA[
68
69 TXT1 = ['scilab','SciLab';'Strcmp','STRcmp'];
70 TXT2 = ['ScIlAb','sciLab';'sTrCmP','StrCMP'];
71 strcmp(TXT1,TXT2)
72 strcmp(TXT1,'scilab')
73 strcmp(TXT1,'SciLab')
74 strcmp(TXT1,TXT2,'i')
75  
76   ]]></EXAMPLE>
77
78   <SEE_ALSO>
79     <SEE_ALSO_ITEM>
80       <LINK>strcat</LINK>
81     </SEE_ALSO_ITEM>
82
83     <SEE_ALSO_ITEM>
84       <LINK>strcmpi</LINK>
85     </SEE_ALSO_ITEM>
86   </SEE_ALSO>
87 </MAN>