PxConfigNextSection(), PxConfigNextSectionCx()

Seek the beginning of the next section of a configuration file

Synopsis:

#include <photon/PxProto.h>

const char *PxConfigNextSection( void );

const char *PxConfigNextSectionCx(PxCfgContext_t *cx);

Arguments:

cx

PxConfigNextSectionCx() 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 next 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 aren't any more sections (that is, the current section is the last section) the function returns NULL, but the current section and file pointer are left untouched.

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

Returns:

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

Examples:

    char *section;
    while ((section = PxConfigNextSection()) != NULL) {
        PxConfigReadShort(NULL, "Size", 0, &recsize);
        PxConfigReadShort(NULL, "Max", 0, &maxrecs);
    }

Classification:

Photon

See also:

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