mirror of
https://github.com/bblanchon/ArduinoJson.git
synced 2025-07-31 19:24:48 +02:00
Updated API Reference (markdown)
Benoît Blanchon
151
API-Reference.md
151
API-Reference.md
@@ -5,51 +5,53 @@ Some parts have been simplified to be easier to understand, so if you look at th
|
|||||||
<!-- MarkdownTOC depth=3 autolink=true bracket=round lowercase_only_ascii=true -->
|
<!-- MarkdownTOC depth=3 autolink=true bracket=round lowercase_only_ascii=true -->
|
||||||
|
|
||||||
- [Configuration](#configuration)
|
- [Configuration](#configuration)
|
||||||
- [ARDUINOJSON_USE_DOUBLE](#arduinojsonusedouble)
|
- [ARDUINOJSON_USE_DOUBLE](#arduinojsonusedouble)
|
||||||
- [ARDUINOJSON_USE_LONG_LONG](#arduinojsonuselonglong)
|
- [ARDUINOJSON_USE_LONG_LONG](#arduinojsonuselonglong)
|
||||||
- [ARDUINOJSON_ENABLE_ARDUINO_STRING](#arduinojsonenablearduinostring)
|
- [ARDUINOJSON_ENABLE_ARDUINO_STRING](#arduinojsonenablearduinostring)
|
||||||
- [ARDUINOJSON_ENABLE_STD_STRING](#arduinojsonenablestdstring)
|
- [ARDUINOJSON_ENABLE_STD_STRING](#arduinojsonenablestdstring)
|
||||||
- [ARDUINOJSON_DEFAULT_NESTING_LIMIT](#arduinojsondefaultnestinglimit)
|
- [ARDUINOJSON_DEFAULT_NESTING_LIMIT](#arduinojsondefaultnestinglimit)
|
||||||
- [JsonArray](#jsonarray)
|
- [JsonArray](#jsonarray)
|
||||||
- [Constructor](#constructor)
|
- [Constructor](#constructor)
|
||||||
- [JsonArray::add\(\)](#jsonarrayadd)
|
- [JsonArray::add\(\)](#jsonarrayadd)
|
||||||
- [JsonArray::createNestedArray\(\)](#jsonarraycreatenestedarray)
|
- [JsonArray::copyFrom\(\)](#jsonarraycopyfrom)
|
||||||
- [JsonArray::createNestedObject\(\)](#jsonarraycreatenestedobject)
|
- [JsonArray::copyTo\(\)](#jsonarraycopyto)
|
||||||
- [JsonArray::get\(\)](#jsonarrayget)
|
- [JsonArray::createNestedArray\(\)](#jsonarraycreatenestedarray)
|
||||||
- [JsonArray::measureLength\(\)](#jsonarraymeasurelength)
|
- [JsonArray::createNestedObject\(\)](#jsonarraycreatenestedobject)
|
||||||
- [JsonArray::measurePrettyLength\(\)](#jsonarraymeasureprettylength)
|
- [JsonArray::get\(\)](#jsonarrayget)
|
||||||
- [JsonArray::operator\[\]](#jsonarrayoperator)
|
- [JsonArray::measureLength\(\)](#jsonarraymeasurelength)
|
||||||
- [JsonArray::prettyPrintTo\(\)](#jsonarrayprettyprintto)
|
- [JsonArray::measurePrettyLength\(\)](#jsonarraymeasureprettylength)
|
||||||
- [JsonArray::printTo\(\)](#jsonarrayprintto)
|
- [JsonArray::operator\[\]](#jsonarrayoperator)
|
||||||
- [JsonArray::removeAt\(\)](#jsonarrayremoveat)
|
- [JsonArray::prettyPrintTo\(\)](#jsonarrayprettyprintto)
|
||||||
- [JsonArray::set\(\)](#jsonarrayset)
|
- [JsonArray::printTo\(\)](#jsonarrayprintto)
|
||||||
- [JsonArray::size\(\)](#jsonarraysize)
|
- [JsonArray::removeAt\(\)](#jsonarrayremoveat)
|
||||||
- [JsonArray::success\(\)](#jsonarraysuccess)
|
- [JsonArray::set\(\)](#jsonarrayset)
|
||||||
|
- [JsonArray::size\(\)](#jsonarraysize)
|
||||||
|
- [JsonArray::success\(\)](#jsonarraysuccess)
|
||||||
- [JsonBuffer \(DynamicJsonBuffer and StaticJsonBuffer\)](#jsonbuffer-dynamicjsonbuffer-and-staticjsonbuffer)
|
- [JsonBuffer \(DynamicJsonBuffer and StaticJsonBuffer\)](#jsonbuffer-dynamicjsonbuffer-and-staticjsonbuffer)
|
||||||
- [JsonBuffer::createArray\(\)](#jsonbuffercreatearray)
|
- [JsonBuffer::createArray\(\)](#jsonbuffercreatearray)
|
||||||
- [JsonBuffer::createObject\(\)](#jsonbuffercreateobject)
|
- [JsonBuffer::createObject\(\)](#jsonbuffercreateobject)
|
||||||
- [JsonBuffer::parseArray\(\)](#jsonbufferparsearray)
|
- [JsonBuffer::parseArray\(\)](#jsonbufferparsearray)
|
||||||
- [JsonBuffer::parseObject\(\)](#jsonbufferparseobject)
|
- [JsonBuffer::parseObject\(\)](#jsonbufferparseobject)
|
||||||
- [JsonBuffer::strdup\(\)](#jsonbufferstrdup)
|
- [JsonBuffer::strdup\(\)](#jsonbufferstrdup)
|
||||||
- [JsonObject](#jsonobject)
|
- [JsonObject](#jsonobject)
|
||||||
- [Constructor](#constructor-1)
|
- [Constructor](#constructor-1)
|
||||||
- [JsonObject::begin\(\) / JsonObject::end\(\)](#jsonobjectbegin--jsonobjectend)
|
- [JsonObject::begin\(\) / JsonObject::end\(\)](#jsonobjectbegin--jsonobjectend)
|
||||||
- [JsonObject::createNestedArray\(\)](#jsonobjectcreatenestedarray)
|
- [JsonObject::createNestedArray\(\)](#jsonobjectcreatenestedarray)
|
||||||
- [JsonObject::createNestedObject\(\)](#jsonobjectcreatenestedobject)
|
- [JsonObject::createNestedObject\(\)](#jsonobjectcreatenestedobject)
|
||||||
- [JsonObject::containsKey\(\)](#jsonobjectcontainskey)
|
- [JsonObject::containsKey\(\)](#jsonobjectcontainskey)
|
||||||
- [JsonObject::get\(\)](#jsonobjectget)
|
- [JsonObject::get\(\)](#jsonobjectget)
|
||||||
- [JsonObject::measureLength\(\)](#jsonobjectmeasurelength)
|
- [JsonObject::measureLength\(\)](#jsonobjectmeasurelength)
|
||||||
- [JsonObject::measurePrettyLength\(\)](#jsonobjectmeasureprettylength)
|
- [JsonObject::measurePrettyLength\(\)](#jsonobjectmeasureprettylength)
|
||||||
- [JsonObject::operator\[\]](#jsonobjectoperator)
|
- [JsonObject::operator\[\]](#jsonobjectoperator)
|
||||||
- [JsonObject::prettyPrintTo\(\)](#jsonobjectprettyprintto)
|
- [JsonObject::prettyPrintTo\(\)](#jsonobjectprettyprintto)
|
||||||
- [JsonObject::printTo\(\)](#jsonobjectprintto)
|
- [JsonObject::printTo\(\)](#jsonobjectprintto)
|
||||||
- [JsonObject::remove\(\)](#jsonobjectremove)
|
- [JsonObject::remove\(\)](#jsonobjectremove)
|
||||||
- [JsonObject::set\(\)](#jsonobjectset)
|
- [JsonObject::set\(\)](#jsonobjectset)
|
||||||
- [JsonObject::size\(\)](#jsonobjectsize)
|
- [JsonObject::size\(\)](#jsonobjectsize)
|
||||||
- [JsonObject::success\(\)](#jsonobjectsuccess)
|
- [JsonObject::success\(\)](#jsonobjectsuccess)
|
||||||
- [JsonVariant](#jsonvariant)
|
- [JsonVariant](#jsonvariant)
|
||||||
- [JsonVariant::as\(\)](#jsonvariantas)
|
- [JsonVariant::as\(\)](#jsonvariantas)
|
||||||
- [JsonVariant::is\(\)](#jsonvariantis)
|
- [JsonVariant::is\(\)](#jsonvariantis)
|
||||||
|
|
||||||
<!-- /MarkdownTOC -->
|
<!-- /MarkdownTOC -->
|
||||||
|
|
||||||
@@ -182,6 +184,73 @@ will write
|
|||||||
["hello",3.1416]
|
["hello",3.1416]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### JsonArray::copyFrom()
|
||||||
|
|
||||||
|
##### Description
|
||||||
|
|
||||||
|
Populates the `JsonArray` with values from a C array.
|
||||||
|
|
||||||
|
##### Signatures
|
||||||
|
|
||||||
|
```c++
|
||||||
|
JsonArray::copyFrom(int array[]);
|
||||||
|
JsonArray::copyFrom(double array[]);
|
||||||
|
JsonArray::copyFrom(const char* array[]);
|
||||||
|
```
|
||||||
|
|
||||||
|
##### Return value
|
||||||
|
|
||||||
|
`true` if the operation is successful; or `false` if there was not enough room in the `JsonBuffer`.
|
||||||
|
|
||||||
|
##### Example
|
||||||
|
|
||||||
|
```c++
|
||||||
|
int values[] = {1, 2, 3};
|
||||||
|
|
||||||
|
StaticJsonBuffer<200> jsonBuffer;
|
||||||
|
JsonArray& array = jsonBuffer.createArray();
|
||||||
|
array.copyFrom(values);
|
||||||
|
array.printTo(Serial);
|
||||||
|
```
|
||||||
|
|
||||||
|
will write
|
||||||
|
|
||||||
|
```json
|
||||||
|
[1,2,3]
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### JsonArray::copyTo()
|
||||||
|
|
||||||
|
##### Description
|
||||||
|
|
||||||
|
Extracts a C array from the `JsonArray`.
|
||||||
|
|
||||||
|
##### Signatures
|
||||||
|
|
||||||
|
```c++
|
||||||
|
JsonArray::copyTo(int array[]);
|
||||||
|
JsonArray::copyTo(double array[]);
|
||||||
|
JsonArray::copyTo(const char* array[]);
|
||||||
|
```
|
||||||
|
|
||||||
|
##### Return value
|
||||||
|
|
||||||
|
A `size_t` containing the number of values written in the array.
|
||||||
|
|
||||||
|
##### Example
|
||||||
|
|
||||||
|
```c++
|
||||||
|
int values[3];
|
||||||
|
|
||||||
|
StaticJsonBuffer<200> jsonBuffer;
|
||||||
|
JsonArray& array = jsonBuffer.parseArray("[1,2,3]");
|
||||||
|
array.copyTo(values);
|
||||||
|
```
|
||||||
|
|
||||||
|
now `values` contais `1`, `2` and `3`.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### JsonArray::createNestedArray()
|
### JsonArray::createNestedArray()
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user