PxConfigWriteBool(), PxConfigWriteBoolCx()

Write a Boolean parameter in a configuration file

Synopsis:

#include <photon/PxProto.h>

int PxConfigWriteBool( const char *section,
                       const char *entry,
                       int format,
                       int value );

int PxConfigWriteBoolCx( PxCfgContext_t *cx,
                         const char *section,
                         const char *entry,
                         int format,
                         int value );

Arguments:

cx

PxConfigWriteBoolCx() only. The configuration file handle for the file you want to write to. This handle is returned by PxConfigOpenCx().

section

The section to write value to.
If section matches a valid section name, it becomes the current section. If section is NULL, the function writes to the current section. If section doesn't exist, the function creates it and makes it the current section.

entry

The entry to write value to. If the entry already exists in the current section, it's overwritten; otherwise, it's added to the end of the section.

format

Determines how the value is formatted:

Format	Output
PXCONFIG_FMT_BOOL_ON	`OFF` or `ON`
PXCONFIG_FMT_BOOL_YES	`NO` or `YES`
PXCONFIG_FMT_BOOL_TRUE	`FALSE` or `TRUE`

value

The value the function writes to the file.

Library:

phexlib

Description:

These functions write a Boolean parameter in the specified section and entry of a configuration file.

The configuration file must have been opened by PxConfigOpen*() with a mode of PXCONFIG_WRITE.
If the specified section doesn't exist, it's created.
To create an empty section, call PxConfigForceEmptySection* ().

PxConfigWriteBool() writes to the currently open configuration file opened by PxConfigOpen(), while PxConfigWriteBoolCx() writes to the configuration file indicated by cx.

Returns:

Pt_TRUE if the entry is written, otherwise Pt_FALSE

Classification:

Photon

Safety:
Interrupt handler	No
Signal handler	No
Thread	No