PxConfigReadChar()

Read a character parameter from a configuration file

Synopsis:

#include <photon/PxProto.h>

int PxConfigReadChar( const char *section, 
                      const char *entry, 
                      char dflt, 
                      char *value );

Description:

PxConfigReadChar() reads a character parameter from the specified section and entry of the configuration file. If section is NULL, the function reads the value from entry in the current section.

PxConfigReadChar() accepts digits (signed and unsigned) within the char range, or a single letter, and stores the value in *value. For all other (invalid or nonexistent) values, the default value dflt is stored instead. If the required section or entry doesn't exist, the default value is stored in *value.

Returns:

Pt_TRUE if the required section/entry exists and the given value is valid, otherwise Pt_FALSE.

Classification:

Photon

See also:

PxConfigOpen(), PxConfigReadBool(), PxConfigReadInt(), PxConfigReadLong(), PxConfigReadShort(), PxConfigReadString(), PxConfigWriteBool(), PxConfigWriteChar(), PxConfigWriteInt(), PxConfigWriteLong(), PxConfigWriteShort(), PxConfigWriteString()