aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/arduino/stringobject.rst
blob: ffee295c097f503200818f07cd0422fbbfc2a8b6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
.. _arduino-stringobject:

String
======

Description
-----------

The String class, part of the core as of version 0019, allows you
to use and manipulate strings of text in more complex ways than
`character arrays <http://arduino.cc/en/Reference/String>`_ do. You
can concatenate Strings, append to them, search for and replace
substrings, and more. It takes more memory than a simple character
array, but it is also more useful.



For reference, character arrays are referred to as strings with a
small s, and instances of the String class are referred to as
Strings with a capital S. Note that constant strings, specified in
"double quotes" are treated as char arrays, not instances of the
String class.



Functions
---------


-  `String <http://arduino.cc/en/Reference/StringConstructor>`_\ ()
-  `charAt <http://arduino.cc/en/Reference/StringCharAt>`_\ ()
-  `compareTo <http://arduino.cc/en/Reference/StringCompareTo>`_\ ()
-  `concat <http://arduino.cc/en/Reference/StringConcat>`_\ ()
-  `endsWith <http://arduino.cc/en/Reference/StringEndsWith>`_\ ()
-  `equals <http://arduino.cc/en/Reference/StringEquals>`_\ ()
-  `equalsIgnoreCase <http://arduino.cc/en/Reference/StringEqualsIgnoreCase>`_\ ()
-  `getBytes <http://arduino.cc/en/Reference/StringGetBytes>`_\ ()
-  `indexOf <http://arduino.cc/en/Reference/StringIndexOf>`_\ ()
-  `lastIndexOf <http://arduino.cc/en/Reference/StringLastIndexOf>`_\ ()
-  `length <http://arduino.cc/en/Reference/StringLength>`_\ ()
-  `replace <http://arduino.cc/en/Reference/StringReplace>`_\ ()
-  `setCharAt <http://arduino.cc/en/Reference/StringSetCharAt>`_\ ()
-  `startsWith <http://arduino.cc/en/Reference/StringStartsWith>`_\ ()
-  `substring <http://arduino.cc/en/Reference/StringSubstring>`_\ ()
-  `toCharArray <http://arduino.cc/en/Reference/StringToCharArray>`_\ ()
-  `toLowerCase <http://arduino.cc/en/Reference/StringToLowerCase>`_\ ()
-  `toUpperCase <http://arduino.cc/en/Reference/StringToUpperCase>`_\ ()
-  `trim <http://arduino.cc/en/Reference/StringTrim>`_\ ()



Operators
---------


-  `[] (element access) <http://arduino.cc/en/Reference/StringBrackets>`_
-  `+ (concatenation) <http://arduino.cc/en/Reference/StringPlus>`_
-  `== (comparison) <http://arduino.cc/en/Reference/StringComparison>`_



Examples
--------


-  `StringConstructors <http://arduino.cc/en/Tutorial/StringConstructors>`_
-  `StringAdditionOperator <http://arduino.cc/en/Tutorial/StringAdditionOperator>`_
-  `StringIndexOf <http://arduino.cc/en/Tutorial/StringIndexOf>`_
-  `StringAppendOperator <http://arduino.cc/en/Tutorial/StringAppendOperator>`_
-  `StringLengthTrim <http://arduino.cc/en/Tutorial/StringLengthTrim>`_
-  `StringCaseChanges <http://arduino.cc/en/Tutorial/StringCaseChanges>`_
-  `StringReplace <http://arduino.cc/en/Tutorial/StringReplace>`_
-  `StringCharacters <http://arduino.cc/en/Tutorial/StringCharacters>`_
-  `StringStartsWithEndsWith <http://arduino.cc/en/Tutorial/StringStartsWithEndsWith>`_
-  `StringComparisonOperators <http://arduino.cc/en/Tutorial/StringComparisonOperators>`_
-  `StringSubstring <http://arduino.cc/en/Tutorial/StringSubstring>`_



See Also
--------


-  `string <http://arduino.cc/en/Reference/String>`_: character
   arrays
-  `Variable Declaration <http://arduino.cc/en/Reference/VariableDeclaration>`_