PxConfigReadDouble(), PxConfigReadDoubleCx()

Read a double-precision float parameter from a configuration file

Synopsis:

#include <photon/PxProto.h>

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

int PxConfigReadDoubleCx( PxCfgContext_t *cx,
                       const char *section,
                       const char *entry,
                       double dflt,
                       double *value );

Arguments:

cx: PxConfigReadDoubleCx() 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.
value: A pointer to a double where the function stores the value it reads.

Library:

phexlib

Description:

These functions read a double-precision float parameter from a configuration file.

PxConfigReadDouble() reads from the currently open configuration file opened by PxConfigOpen(), while PxConfigReadDoubleCx() 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