JSON Decoding and Encoding APIJSON decoder functionality Parent topic: JSON decoder functionality

json_decoder_get_string()

Get the string value from the current or the specified node

Synopsis:

#include <sys/json.h>
json_decoder_error_t json_decoder_get_string(json_decoder_t *decoder,
                                             const char *name,
                                             const char **value,
                                             bool optional);

Arguments:

decoder
The JSON decoder instance.
name
The name of the node to return the value for, or NULL to return the value for the current node.
value
A pointer to the string buffer that will be updated with the value.
optional
Indicates if the presence of this node is optional. When returning values for optional nodes, the decoder will not register an error status if the node does not exist.

Library:

libjson

Description:

This function gets the string value from the current node or from the node with the given name, if the decoder is currently positioned in an object. If successful, the decoder will advance its position to the next node in the object or array.

Note:

Value strings returned by this function continue to be valid until a subsequent call to json_decoder_destroy(), json_decoder_parse_json_str(), or json_decoder_cleanup(), or until json_encoder_*() calls are made on an encoder returned from json_decoder_get_encoder() to update the decoder tree.

Returns:

JSON_DECODER_OK
Success.
JSON_DECODER_BAD_TYPE
The specified node is not a string type.
JSON_DECODER_NOT_FOUND
The specified node does not exist.
Parent topic: JSON decoder functionality