PxConfigFirstSection(), PxConfigFirstSectionCx()

Seek the beginning of the first section of a configuration file

Synopsis:

#include <photon/PxProto.h>

const char *PxConfigFirstSection( void );

const char *PxConfigFirstSectionCx(PxCfgContext_t *cx);

Arguments:

cx

PxConfigFirstSectionCx() only. The configuration file handle for the file you want to seek in. This handle is returned by PxConfigOpenCx().

Library:

phexlib

Description:

These functions seek the start of the first section, and return the name of this section; this section is made the internal current section. These functions may be used to process a configuration file consisting of unknown sections, but where each section has known entries. If there are no sections, the function returns NULL.

PxConfigFirstSection() works on the currently open configuration file opened by PxConfigOpen(), while PxConfigFirstSectionCx() works on the configuration file indicated by cx.

Returns:

A string containing the first section name if one exists, NULL otherwise

Classification:

Photon

See also:

PxConfigNextEntry*(), PxConfigNextSection*(), PxConfigNextString*(), PxConfigOpen*(), PxConfigSection*()