[Previous] [Contents] [Index] [Next]

PxConfigSection()

Seek the start of a given section in a configuration file

Synopsis:

#include <photon/PxProto.h>

int PxConfigSection( const char *section );

Description:

PxConfigSection() seeks to the start of the requested section, and returns an indication of whether the section exists within the configuration file. This function may be used to conditionally process an optional section block. Photon also uses it internally to locate a configuration entry; the section is made the internal current section.


Note: Section names must be an exact match-they must not be abbreviated and the match is case-sensitive.

Returns:

Pt_TRUE if the requested section exists, Pt_FALSE otherwise

Classification:

Photon

Safety:
Interrupt handler No
Signal handler No
Thread No

See also:

PxConfigDeleteSection(), PxConfigForceEmptySection(), PxConfigNextSection(), PxConfigNextString(), PxConfigOpen()


[Previous] [Contents] [Index] [Next]