MACROMEDIA COLDFUSION MX 61-CFML, Reference

Page: 510 / 806

510 Chapter 3: ColdFusion Functions
GetToken
Description
Determines whether a token of the list in the
delimiters
parameter is present in a string.
Returns
The token found at position index of the string, as a string. If index is greater than the number of
tokens in the string, returns an empty string.
Category
String functions
Function syntax
GetToken ( string , index [, delimiters ])
See also
Left , Right , Mid , SpanExcluding , SpanIncluding
Parameters
Usage
The following examples show how this function works.
Example A
: Consider the following code:
GetToken("red,blue:;red,black,tan:;red,pink,brown:;red,three", 2, ":;")
This function call requests element number 2 from the string, using the delimiter "
:;
". The
output is as follows:
red,black,tan
Example B
: Consider the following code:
<cfset mystring = "four,"
& #chr(32)# & #chr(9)# & #chr(10)#
& ",five, nine,zero:;"
& #chr(10)#
& "nine,ten:, eleven:;twelve:;thirteen,"
& #chr(32)# & #chr(9)# & #chr(10)#
& ",four">
<cfoutput>
#mystring#<br><br>
</cfoutput>
Parameter Description
string A string or a variable that contains one. String in which to search.
index Positive integer or a variable that contains one. The position of a token.
delimiters A string or a variable that contains one. A delimited list of delimiters. Elements may
consist of multiple characters.
Default list of delimiters: space character, tab character, newline character; or their
codes: "chr(32)", "chr(9)", chr(10).
Default list delimiter: comma character.