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

See also

Left, Right, Mid, SpanExcluding, SpanIncluding

Parameters

Usage

The following examples show how this function works.

Example 1

In the following example, the function call requests element number 2 from the string, using the delimiter "[:;".

<cfoutput>

    #GetToken("red,blue:;red,black,tan:;red,pink,brown:;red,three", 2, ":;")#

</cfoutput>

The output is as follows:

red,black,tan

Example 2

<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> #HTMLCodeFormat(mystring)#<br><br> </cfoutput>

The output is as follows:

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:

The output of this code is as follows:

The function finds the third delimiter, and returns the substring just before it that is between the second and third delimiter. This substring is ";".

Example 3

The output is as follows:

The following is a call against mystring2:

The output is as follows:

The function finds the second delimiter, and returns the substring just before it that is between the first and second delimiter. This substring is ",five,nine,zero:;".