DBPowerSuite 7.9 Application Programming Interface
Files

 

Class Description

Windows-Style Configuration File

Class Name

PSConfigurationFile

Parent Class

ULogObject

Header Name

PSConfigurationFile.h

Library

libpsUCommon

Language

C++

Author

Brian N. Ceccarelli

Location

Apex, NC

Date Written

September 13, 2004

Last Updated

September 13, 2004

Last Updated By

Brian N. Ceccarelli

Notes

     This class manages a Windows-style text configuration file.
Such a configuration file is broken down into sections, each section
containing records of key/value pairs.   Section headers are
in brackets.  Key/value pairs are separated by an equal sign.
Comments are lines beginning with #.

     An example file looks like:

[Oracle]
TABLE=create table __TABLE__ (__COLUMN_LIST)
INDEX=create index __INDEX__ on __TABLE__ (__COLUMNS__)

See Also

UKeyedList

 

Public Methods of Class PSConfigurationFile

#

Inline

Pure Virtual

Virtual

Method

Description

1

No

No

No

PSConfigurationFile()

Constructor

2

No

No

No

ps_int32 cfGetCommentCharacters(ps_char* comment_characters) const

Get the Comment Characters

3

Yes

No

No

ps_int8 cfGetFileLoadedSw() const

 

4

No

No

No

ps_int32 cfGetFileName(ps_char* file_name) const

Get the File Name

5

No

No

No

ps_int32 cfGetValue(const ps_char* section_name, const ps_char* key_name, ps_char* value, ps_int32 max_value_len = 512)

Get a Value from the Config File

6

No

No

No

ps_float32 cfGetValueFloat32(const ps_char* section_name, const ps_char* key_name, ps_int32* status = NULL)

Get a Value from the Config File

7

No

No

No

ps_float64 cfGetValueFloat64(const ps_char* section_name, const ps_char* key_name, ps_int32* status = NULL)

Get a Value from the Config File

8

No

No

No

ps_int32 cfGetValueInt32(const ps_char* section_name, const ps_char* key_name, ps_int32* status = NULL)

Get a Value from the Config File

9

No

No

No

ps_int64 cfGetValueInt64(const ps_char* section_name, const ps_char* key_name, ps_int32* status = NULL)

Get a Value from the Config File

10

No

No

No

ps_int32 cfLoadFile()

Load the Configuration File

11

No

No

No

ps_int32 cfSetFileName(const ps_char* file_name)

Set the File Name

12

No

No

No

ps_int32 cfUnloadFile()

Unload the Configuration File

13

No

No

Yes

ps_int32 logSetMessages(Messages* msg)

Set the Log Messages File

14

No

No

No

~PSConfigurationFile()

Destructor

 

Protected Methods of Class PSConfigurationFile

#

Inline

Pure Virtual

Virtual

Method

Description

 

Private Methods of Class PSConfigurationFile

#

Inline

Pure Virtual

Virtual

Method

Description

 

Go to DBPowerSuite 7.9 Application Programming Interface.


Updated: Thu Jun 18 21:13:23 2009