Objective Systems, Inc.  

Configuration file handling functions.

General utility functions for reading and searching configuration files. More...

Data Structures

struct  OOConfigNVP
struct  OOConfigSection
struct  OOConfigFile

Functions

EXTERN int ooConfigInit (OOConfigFile *pconfig)
 This function initializes a configuration file structure.
EXTERN void ooConfigCtxtInit (OOCTXT *pctxt, OOConfigFile *pconfig)
 This function initializes a configuration file structure using an existing context.
EXTERN int ooConfigFileRead (const char *filename, OOConfigFile *pconfig)
 This function reads the contents of a configuration file into a configuration structure.
EXTERN void ooConfigDestroy (OOConfigFile *pconfig)
 This function destroys an existing in-memory configuration structure.
EXTERN void ooConfigPrint (OOConfigFile *pconfig)
 This function prints the contents of an in-memory configuration structure.

Detailed Description

General utility functions for reading and searching configuration files.

Function Documentation

EXTERN int ooConfigInit ( OOConfigFile *  pconfig  ) 

This function initializes a configuration file structure.

It should be the first function called with the given list structure.

Parameters:
pconfig Pointer to configuration file variable.
Returns:
0 if successful, ASN_E_NOMEM if memory could not be allocated for the context.

EXTERN void ooConfigCtxtInit ( OOCTXT *  pctxt,
OOConfigFile *  pconfig 
)

This function initializes a configuration file structure using an existing context.

This is more efficient then the default initialization which creates a new context.

Parameters:
pctxt Pointer to an existing initialized context.
pconfig Pointer to configuration file variable.

EXTERN int ooConfigFileRead ( const char *  filename,
OOConfigFile *  pconfig 
)

This function reads the contents of a configuration file into a configuration structure.

Parameters:
filename Full path to a configuration file.
pconfig Pointer to configuration file variable.
Returns:
Status of operation: 0 if successful or a negative status code if error.

EXTERN void ooConfigDestroy ( OOConfigFile *  pconfig  ) 

This function destroys an existing in-memory configuration structure.

Parameters:
pconfig Pointer to configuration file variable.

EXTERN void ooConfigPrint ( OOConfigFile *  pconfig  ) 

This function prints the contents of an in-memory configuration structure.

Parameters:
pconfig Pointer to configuration file variable.

This file was last modified on 28 May 2010.
Objective Open H.323 Stack, 0.9.1