PPS API reference

Updated: October 28, 2024

This chapter describes the publicly visible PPS API functions and data types.

The PPS header file pps.h is found in the $QNX_TARGET/usr/include/sys directory.

pps_attrib_flags_t
The states for PPS objects and attributes
pps_attrib_t
pps_attrib_t
pps_decoder_cleanup()
Clean up a pps_decoder_t structure
pps_decoder_dump_tree()
Write a decoded PPS data structure in human-readable format to a file
pps_decoder_error_t
pps_decoder_error_t
pps_decoder_flags()
Return the flags associated with the current or named attribute
pps_decoder_get_bool()
Extract a Boolean value from the current or named node
pps_decoder_get_double()
Extract a double value from the current or named node
pps_decoder_get_int()
Extract an integer value from the current or named node
pps_decoder_get_int64()
Extract a 64-bit integer value from the current or named node
pps_decoder_get_state()
Return the current state of the decoder
pps_decoder_get_string()
Extract a string value from a node
pps_decoder_goto_index()
Advance to the indicated element or property of an array or object
pps_decoder_initialize()
Initialize the decoder structure
pps_decoder_is_integer()
Test whether a node is an integer
pps_decoder_length()
Return the number of elements or properties in the current object or array
pps_decoder_name()
Return the name of the current node
pps_decoder_next()
Advance to the next node
pps_decoder_parse_json_str()
Parse a string of JSON-formatted data
pps_decoder_parse_pps_str()
Parse a string of PPS-formatted data
pps_decoder_pop()
Ascend to the parent of the current node
pps_decoder_push()
Descend into a lower-level node
pps_decoder_push_array()
Descend into a lower-level array
pps_decoder_push_object()
Descend into a lower-level object
pps_decoder_reset()
Reset the pps_decoder_t structure
pps_decoder_set_position()
Position the decoder at the specified node
pps_decoder_set_state()
Set the state of the decoder
pps_decoder_state_t
pps_decoder_state_t
pps_decoder_status()
Return the current error status of the decoder
pps_decoder_t
pps_decoder_t
pps_decoder_type()
Return the data type of the current or named node
pps_encoder_add_bool()
Add a Boolean to the current object or array
pps_encoder_add_double()
Add a double to the current object or array
pps_encoder_add_from_decoder()
Add part or all of the contents of a decoder to an encoder
pps_encoder_add_int()
Add an integer to the current object or array
pps_encoder_add_int64()
Add a 64-bit integer to the current object or array
pps_encoder_add_json()
Add a JSON-encoded string to the current object or array
pps_encoder_add_null()
Add a null to the current object or array
pps_encoder_add_string()
Add a string to the current object or array
pps_encoder_buffer()
Return a pointer to the buffer holding the encoded data
pps_encoder_cleanup()
Clean up an encoder structure, releasing any allocated memory
pps_encoder_clear_option()
Disable an encoder option
pps_encoder_delete_attribute()
Add an attribute and mark it as deleted
pps_encoder_end_array()
End the current array
pps_encoder_end_object()
End the current object
pps_encoder_error_t
pps_encoder_error_t
pps_encoder_initialize()
Initialize an encoder structure
pps_encoder_length()
Return the length of the encoded data
pps_encoder_reset()
Reset an encoder prior to encoding new data
pps_encoder_set_option()
Enable an encoder option
pps_encoder_start_array()
Start a new array
pps_encoder_start_object()
Start a new object
pps_encoder_t
Encoder structure
pps_node_type_t
pps_node_type_t
pps_options_t
PPS options
pps_status_t
ppsparse() return values
ppsparse()
Parse an object read from PPS