PxConfigDeleteSection(), PxConfigDeleteSectionCx()

Delete a section from a configuration file

Synopsis:

#include <photon/PxProto.h>

int PxConfigDeleteSection( const char *section);

int PxConfigDeleteSectionCx(  PxCfgContext_t *cx,
                              const char *section);

Arguments:

cx: PxConfigDeleteSectionCx() only. The configuration file handle for the file you want to delete a section from. This handle is returned by PxConfigOpenCx().
section: The section to delete.
All entries within the section (up to either the beginning of the next [] section or end-of-file) are deleted. If the deleted section was current, current section is set to none; otherwise, the current section is not changed.
If section is NULL, then the current section is deleted, and the current section is set to “none”.

Description:

These functions delete the section section from the configuration file.

The file must have been opened for PXCONFIG_WRITE—see PxConfigOpen*().

PxConfigDeleteSection() deletes a section from the currently open configuration file opened by PxConfigOpen(), while PxConfigDeleteSectionCx() deletes a section from the configuration file indicated by cx.

Returns:

Pt_TRUE: The section is deleted.
Pt_FALSE: Otherwise.

Classification:

Photon

Safety:
Interrupt handler	No
Signal handler	No
Thread	No