PxConfigDeleteEntry(), PxConfigDeleteEntryCx()

Delete an entry from a configuration file

Synopsis:

#include <photon/PxProto.h>

int PxConfigDeleteEntry( const char *section,
                         const char *entry );

int PxConfigDeleteEntryCx(  PxCfgContext_t *cx,
                            const char *section,
                            const char *entry );

Arguments:

cx

PxConfigDeleteEntryCx() only. The configuration file handle for the file you want to delete an entry from. This handle is returned by PxConfigOpenCx().

section

The section that contains entry.
If section is NULL, then the current section is searched for a match for entry.

entry

The entry to delete.

Library:

phexlib

Description:

These functions delete the entry entry from the section section in a configuration file.

---

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

---

PxConfigDeleteEntry() deletes an entry from the currently open configuration file opened by PxConfigOpen(), while PxConfigDeleteEntryCx() deletes an entry from the configuration file indicated by cx.

Returns:

Pt_TRUE

The entry is deleted.

Pt_FALSE

Otherwise.

Classification:

Photon

See also:

PxConfigDeleteSection*(), PxConfigOpen*()