bad format for help
[scilab.git] / scilab / modules / string / help / en_US / strcspn.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>strcspn</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="strcspn">Get span until character in
13   string</SHORT_DESCRIPTION>
14
15   <CALLING_SEQUENCE>
16     <CALLING_SEQUENCE_ITEM>res =
17     strcspn(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 = strcspn(string_one,string_two)</VERB> Scans string_one for
50     the first occurrence of any of the characters that are part of string_two,
51     returning the number of characters of string_one read before this first
52     occurrence.</P>
53
54     <P>string_two must have same dimensions than string_two or string_two must
55     be a string.</P>
56   </DESCRIPTION>
57
58   <EXAMPLE><![CDATA[
59
60 strcspn("fcba73","1234567890")
61 strcspn(["fcba73","f7cba73"],"1234567890")
62 strcspn(["fcba73","f7cba73"],["312","34567890"])
63  
64   ]]></EXAMPLE>
65
66   <SEE_ALSO>
67     <SEE_ALSO_ITEM>
68       <LINK>strspn</LINK>
69     </SEE_ALSO_ITEM>
70   </SEE_ALSO>
71 </MAN>