PPS API reference

Parent topic: PPS API reference

pps_encoder_start_object()

Updated: October 28, 2024

Start a new object

Synopsis:

#include <sys/pps.h>
            
pps_encoder_error_t pps_encoder_start_object(
                                    pps_encoder_t *encoder, 
                                    const char *name);

Arguments:

encoder: A pointer to the PPS encoder structure.
name: If this object is within another object, name provides the object's property name. If the object is an element of an array, this must be NULL.

Library:

libpps

Description:

The function pps_encoder_start_object() starts a new object. Subsequent properties are added to this object.

Returns:

PPS_ENCODER_OK: Success.
>=1: An error occurred. See pps_decoder_error_t.

Note: The status is sticky. If a call to encode something fails, all subsequent calls will show failure until the encoder is reset.

Classification:

QNX Neutrino

Safety:
Interrupt handler	No
Signal handler	No
Thread	Yes

Parent topic: PPS API reference