String substring Function

Look for “phrases” within a given string.

LAST REVISION:

08/19/2022, 08:23 AM

The String function

substring
(
)

is closely related to

charAt
(
)

,

startsWith
(
)

and

endsWith
(
)

. It allows you to look for an instance of a particular substring within a given String.

Hardware Required

• Arduino Board

Circuit

is closely related toand. It allows you to look for an instance of a particular substring within a given String.

There is no circuit for this example, though your board must be connected to your computer via USB and the serial monitor window of the Arduino Software (IDE) should be open.

Code

substring
(
)

with only one parameter looks for a given substring from the position given to the end of the string. It expects that the substring extends all the way to the end of the String. For example:

1
String
 stringOne 
=
 
"Content-Type: text/html"
;
2
3
if
 
(
stringOne
.
substring
(
19
)
 
==
 
"html"
)
 
{
4
}

with only one parameter looks for a given substring from the position given to the end of the string. It expects that the substring extends all the way to the end of the String. For example:

is true, while

1
String
 stringOne 
=
 
"Content-Type: text/html"
;
2
3
if
 
(
stringOne
.
substring
(
19
)
 
==
 
"htm"
)
 
{
4
}

is not true, because there’s an

l

after the

htm

in the String.

after thein the String.

substring
(
)

with two parameters looks for a given substring from the first parameter to the second. For example:

1
String
 stringOne 
=
 
"Content-Type: text/html"
;
2
3
if
 
(
stringOne
.
substring
(
14
,
18
)
 
==
 
"text"
)
 
{
4
}

with two parameters looks for a given substring from the first parameter to the second. For example:

This looks for the word

text

from positions 14 through 18 of the String.

from positions 14 through 18 of the String.

Caution:
make sure your index values are within the String’s length or you’ll get unpredictable results. This kind of error can be particularly hard to find with the second instance of

substring
(
)

if the starting position is less than the String’s length, but the ending position isn’t.

Learn more

if the starting position is less than the String’s length, but the ending position isn’t.

You can find more basic tutorials in the built-in examples section.

You can also explore the language reference, a detailed collection of the Arduino programming language.

Last revision 2015/08/11 by SM