PxConfigReadLong(), PxConfigReadLongCx()

Read a long integer parameter from a configuration file

Synopsis:

#include <photon/PxProto.h>

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

int PxConfigReadLongCx( PxCfgContext_t *cx,
                        const char *section,
                        const char *entry,
                        long dflt,
                        long *value );

Arguments:

cx: PxConfigReadLongCx() only. The configuration file handle for the file you want to read from. This handle is returned by PxConfigOpenCx().
section: The section to read a value from.
If section is NULL, the function reads the value from entry in the current section. If section is a valid section name, it becomes the current section.
entry: The entry to read the value from.
dflt: The default to store in value if the specified section or entry don't exist, or if the entry value is not a valid long (see below).
value: A pointer to a long where the function stores the value it reads.

Library:

phexlib

Description:

These functions read a long parameter from the specified section and entry of a configuration file and stores it in *value.

The value can be signed. The characters after the sign determine the base:

Character(s):	Base:
`0x` or `0X`	Hexadecimal
`0`	Octal
Other digits	Decimal

PxConfigReadLong() reads from the currently open configuration file opened by PxConfigOpen(), while PxConfigReadLongCx() reads from the configuration file indicated by cx.

Returns:

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

Classification:

Photon

Safety:
Interrupt handler	No
Signal handler	No
Thread	No