PPS API reference

Parent topic: PPS API reference

pps_encoder_add_bool()

Add a Boolean to the current object or array

Synopsis:

#include <pps.h>
            
pps_encoder_error_t pps_encoder_add_bool(
                                    pps_encoder_t *encoder, 
                                    const char *name, 
                                    bool value);

Arguments:

encoder: A pointer to the PPS encoder structure.
name: If the current node is an object, the name of the new attribute. If within an array, this must be NULL.
value: The boolean value to add.

Library:

libpps

Description:

The function pps_encoder_add_bool() adds a boolean value to the current object or array.

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