CPF Class Reference

Inheritance diagram for CPF:

Collaboration diagram for CPF:

Static Public Member Functions
_.Library.Status	Activate ()
	Read and activate the current CPF file. More...
_.Library.Boolean	CPFFileNeedsActivation (_.Library.String Msg)
	Returns 0/1 if the CPF file has been modified but not activated. More...
_.Library.Status	Convert (_.Library.String CPFFile, _.Library.Integer Flags)
	Convert a CPF file to the current version. More...
_.Library.Boolean	PendingRestart (_.Library.String Reasons)
	Determines if a restart of the system is required in order to. More...
_.Library.Status	Validate (_.Library.String CPFFile, _.Library.Integer Flags, _.Library.String ErrorText)
	Validate a CPFFile. More...
	Write (_.Library.String CPFFile)
	Write to the CPF file from the config object. More...

Member Function Documentation

Activate()

_.Library.Status Activate ( )

static

Read and activate the current CPF file.

This method will read the currently active CPF file if it has been updated on disk but not yet read in. After the current settings have been read in, they are activated.

CPFFileNeedsActivation()

_.Library.Boolean CPFFileNeedsActivation ( _.Library.String  Msg )

static

Returns 0/1 if the CPF file has been modified but not activated.

If it has been modified by an editor, an activation must occur before any of the Config methods can be called to activate any additional changes.

Convert()

_.Library.Status Convert ( _.Library.String  CPFFile, _.Library.Integer  Flags  )

static

Convert a CPF file to the current version.

This method will take a CPF file and convert it to the current version. Note that it will not do any validation on the file, it will simply convert it.
Parameters:
CPFFile - CPF file to convert.
Flags - Internal use only, do not pass.

PendingRestart()

_.Library.Boolean PendingRestart ( _.Library.String  Reasons )

static

Determines if a restart of the system is required in order to.

activate modified CPF parameters.
Return Values:
0 - Restart is not required
1 - Restart is required
Reasons - If a restart is required, an array of reasons why in the following format.
Reasons=1
Reasons(1,"New")=New value
Reasons(1,"Old")=Old Value
Reasons(1,"Property")=Property name
Reasons(1,"Section")=Section name
Reasons(1)="Restart required because section [xxx], property yyy modified, new value:zzz, old value:zzz"
Note that if the CPF file has been modified, but not yet activated, this method will return 1, and the following array:
Reasons=1
Reasons(1)="Restart or reactivation required because the CPF file xxxx has been modified, but not activated"
Reasons(1,"New")=""
Reasons(1,"Old")=""
Reasons(1,"Property")=""
Reasons(1,"Section")=""

Validate()

_.Library.Status Validate ( _.Library.String  CPFFile, _.Library.Integer  Flags, _.Library.String  ErrorText  )

static

Validate a CPFFile.

CPFFile - CPF file to validate.
Flags - Options for error text. Macros defined in syConfig.inc.
Bit $$$ErrorTextToScreen - Write error text to terminal
Bit $$$ErrorTextToConsole - Write error text to messages.log
Bit $$$ErrorTextToArray - Return error text in ErrorText array

Write()

Write ( _.Library.String  CPFFile )

static

Write to the CPF file from the config object.

Parameters:
CPFFile - CPF file to write, default is currently active one.