DBPowerSuite 7.9 Application Programming Interface
Files

 

Class Description

Parameters File Manager

Class Name

Parameters

Header Name

Parameters.h

Library

libpsUCommon

Language

C++

Author

Brian N. Ceccarelli

Location

Apex, NC

Date Written

May 22, 1995

Last Updated

January 8, 2001

Last Updated By

Brian N. Ceccarelli

Notes

      A parameters file is an "indexed file".   An indexed file
is a file whose records are organized by key and value.   PS has
a parameters file called the "system's parameter file."   It
contains all the parameters which a PS app may need to run.   The
file's purpose is like that of the Windows registry.   The text form
of the system parameters file is utilities/parameters/parameters.txt.
You make the index file from the text file by running program
psLoadParameters.

      The Parameters class gives the calling application access
to a parameters file.   You can read and update parameters in the
file but you cannot add new parameters.

      Under the covers, a Parameters object uses the UIndexFile
class to manage the indexed file.

      A parameters file has a text key and a text value.   If you
want other data types for keys and values, you must use the
UIndexFile class directly.

See Also

UIndexFile

 

Public Methods of Class Parameters

#

Inline

Pure Virtual

Virtual

Method

Description

1

No

No

No

Parameters()

 

2

No

No

No

ps_int32 paCloseFile()

 

3

No

No

No

ps_int32 paOpenFile()

 

4

No

No

No

ps_int32 paOpenFile(const ps_char* parameters_file)

 

5

No

No

No

ps_int32 paReadFirstParameter(ps_char* key, ps_char* parameter)

 

6

No

No

No

ps_int32 paReadNextParameter(ps_char* key, ps_char* parameter)

 

7

No

No

No

ps_int32 paReadParameter(const ps_char* key, ps_char* parameter)

 

8

No

No

No

ps_int32 paSetWriteEnableSw(ps_int8 sw = 1)

 

9

No

No

No

ps_int32 paUpdateParameter(const ps_char* key, ps_char* parameter)

 

10

No

No

No

~Parameters()

 

 

Protected Methods of Class Parameters

#

Inline

Pure Virtual

Virtual

Method

Description

 

Private Methods of Class Parameters

#

Inline

Pure Virtual

Virtual

Method

Description

 

Go to DBPowerSuite 7.9 Application Programming Interface.


Updated: Thu Jun 18 21:13:23 2009