Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  

AnyConfig::CorbaConfig Interface Reference

The interface specification for the Corba configuration server. More...

#include <AnyCorbaCfg.idl>

Inheritance diagram for AnyConfig::CorbaConfig::

AnyConfig::CorbaConfig_impl List of all members.

Public Types

typedef sequence<AcValuePairAcValuePairSeq
 A sequence of AcValuePair. More...

typedef sequence<AcSectionAcFullConfig
 The complete configuration. More...


Public Methods

boolean getFullConfig (out AcFullConfig cfg)
 Get a copy of the complete configuration. More...

boolean getSection (in string sectionName, out AcValuePairSeq valuePairs)
 Get a copy of a section in the configuration. More...

boolean getValuePair (in string sectionName, in string key, out string value)
 Fetch a configuration value. More...

boolean setValuePair (in string sectionName, in string key, in string value)
 Create or update a configuration value. More...


Detailed Description

The interface specification for the Corba configuration server.


Member Typedef Documentation

typedef sequence< AcSection > AnyConfig::CorbaConfig::AcFullConfig
 

The complete configuration.

typedef sequence< AcValuePair > AnyConfig::CorbaConfig::AcValuePairSeq
 

A sequence of AcValuePair.


Member Function Documentation

boolean AnyConfig::CorbaConfig::getFullConfig ( out AcFullConfig cfg )
 

Get a copy of the complete configuration.

Parameters:
cfg   Will contain the complete configuration if the base configuration supports iteration.
Returns:
False if there is some problem with iterating the base configuration, true otherwise.

boolean AnyConfig::CorbaConfig::getSection ( in string sectionName,
out AcValuePairSeq valuePairs )
 

Get a copy of a section in the configuration.

Parameters:
sectionName   The section to fetch.
valuePairs   Will contain all the key/value paird in the section if the base configuration supports iteration.
Returns:
False if there is some problem with iterating the base configuration or if the section didn't exist, true otherwise.

boolean AnyConfig::CorbaConfig::getValuePair ( in string sectionName,
in string key,
out string value )
 

Fetch a configuration value.

Parameters:
sectionName   The section, may be an empty string.
key   The name of the value to fetch.
value   The value requested.
Returns:
True unless the key does not exist in the specified section.

boolean AnyConfig::CorbaConfig::setValuePair ( in string sectionName,
in string key,
in string value )
 

Create or update a configuration value.

Parameters:
sectionName   The section, may be an empty string.
key   The name of the value to set.
value   The value to set.
Returns:
True unless an error occurred.


The documentation for this interface was generated from the following file:
Generated at Wed Nov 21 11:34:18 2001 for AnyConfig by doxygen1.2.8.1 written by Dimitri van Heesch, © 1997-2001