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>

The output is as follows: 

four,
,five, nine,zero:;
nine,ten:, eleven:;twelve:;thirteen, 
,four

The GetToken function recognizes explicit spaces, tabs, or newline characters as the parameter delimiters (To specify a space character, the code is chr(32); a tab character, chr(9); and a newline character, chr(10).)

In the example string mystring, there is:

  • A forced space between the substrings "four," and ",five"
  • A literal space between "five," and "nine"
  • A literal space between "ten:," and "eleven,"
  • A forced space between "thirteen," and ",four"

In the following call against mystring, no spaces are specified in delimiters (it is omitted), so the function uses the space character as the string delimiter: 

<br>
<cfoutput>
GetToken(mL)(
1XLjXL)(
,%LjXL)&*A>A0Kj
{SLL)(
L jXL)(
,%LjXL)&*A580Kj
{SLL)(
L(jXL)J(
,%LjXL)&*A580vj{S
		LL)(
(L

L0jX(
L)(
%~
(
,(S
,%LjXL)&*AEP%0vj{S
		LL)(
(L

L8jX(
L)(
%~
(
,(S
,%LjXL)&*AEP%0Jj~;-:{S
:LL)/+9;,%LjXL)&~9*0jj
j,#(
(
LL)
(
{S:LL)
(
	LHjXL)
(
(N
4,%LjXL)&,%LjXL)&	,	%LjXL)&*A	dm40jj
j,#(
(
LL)
(
{SLL)
(
	L@jXL)
(
(N
4,%LjXL)&,%LjXL)&	,	%LjXL)&*A	dm40Tj
{SLL)(
1XLjXL)(
,%LjXL)&*A>A0Tj
{SLL)(
3+
	LjXL)(
,%LjXL)&*A>A0Tj
{SLL)(
3+
	LjXL)(
,%LjXL)&*A>A0j
{SLL)(
3+LjX|Uq(
|Vq(
L)(
,%LjXL)&3+
	}T(N
*Adg0j{S
		LL)(
(L

LjX{T(
|Vq(
L)/(S
7s6
(L

(
@|Uq~
(
,|Uq(S
,%LjXL)&}U(N
*Au@0j{S
		LL)(
(L

LjX{T|Uq(
(
L)/(S
8s6
(L

(
@|Vq~
(
,|Vq(S
,%LjXL)&}V(N
*Au@0Kj
{SLL)(
LjXL)(
,%LjXL)&*A580vj{S
		LL)(
(L

L jX(
L)(
%~
(
,(S
,%LjXL)&*AEP%0vj{S
		LL)(
(L

L(jX(
L)(
%~
(
,(S
,%LjXL)&*AEP%0Kj
{SLL)(
LjXL)(
,%LjXL)&*A580j{S
		LL)(
(P
(R

(Q
L jX(
L)(
%~
(
,(S
,%LjXL)&*A\g%0&(
~W)%LjXL)&(
*0A(v
-sT
z~X)2L jXL)&%LjXL)&*0B(
(
j}Z~Y)%LjXL)&(
}Z*0!{Z
,%LjXL)&j}Z*0kj
j(
(

LL)(
{Z
		LjXL)(
#,%LjXL)&,%LjXL)&*AAG#0kj
j(
(

LL)(
{Z
		L jXL)(
#,%LjXL)&,%LjXL)&*AAG#0{Z%L(jXL)(
*0{Z%L0jXL)(
*0|jjj(p
 T3*2)LL)
 @3%LjXL)&*,%LjXL)&,%LjXL)&(
*0
(O
o*0
(O
o*HE3H;uHAH;BuAE