FBConfigFile Class Reference

Interface to the application config files. More...

#include <pyfbsdk.h>

Inheritance diagram for FBConfigFile:

Public Member Functions
	FBConfigFile (str pConfigFileName, bool pVirtualMode=False, bool pClearFile=False)
	Constructor.
	FBConfigFile (str pConfigFileName, str pConfigFilePath, bool pVirtualMode=False, bool pClearFile=False)
	Constructor.
	ClearFile ()
	Remove all content from the config file.
str	Get (str pSectionName, str pItemName, str pDefaultValue=0)
	Get an item's value.
bool	GetOrSet (str pSectionName, str pItemName, str pValue, str pComment=0)
	Get a value from the config file and set it if it was not found.
bool	Set (str pSectionName, str pItemName, str pValue, str pComment=0)
	Set an item's value.

Detailed Description

Interface to the application config files.

This class allows client code to generate, modify and query configuration files. Config files will be automatically created when needed. They will be located in the /bin/config folder or an explicitly specified folder depending on the constructor used.

See samples: FBConfigFile.py, ActionScriptMgr.py, ActionScriptMgr.py, ShotTrackSetupTool.py.

Constructor & Destructor Documentation

FBConfigFile() [1/2]

FBConfigFile	(	str	pConfigFileName,
		bool	pVirtualMode = False,
		bool	pClearFile = False
	)

Constructor.

This will open the desired config file from the [APPLICATION]/bin/config folder. The file will be created if it does not exists. By prefixing the character '@' to the file name, this will automatically prepend the current machine name to the config file, the way it is done for the other config files of the application.

Parameters

pConfigFileName	Name the config file to use.
pVirtualMode	Enable this to limit disk access, file will only be read at construction and written at destruction.
pClearFile	Remove all existing content from the config file.

FBConfigFile() [2/2]

FBConfigFile	(	str	pConfigFileName,
		str	pConfigFilePath,
		bool	pVirtualMode = False,
		bool	pClearFile = False
	)

Constructor.

This will open the desired config file in the designed folder. The file will be created if it does not exists. By prefixing the character '@' to the file name, this will automatically prepend the current machine name to the config file, the way it is done for the other config files of the application.

Parameters

pConfigFileName	Name the config file to use.
pConfigFilePath	Location where the file should reside. Missing directories will not be created.
pVirtualMode	Enable this to limit disk access, file will only be read at construction and written at destruction.
pClearFile	Remove all existing content from the config file.

Member Function Documentation

ClearFile()

ClearFile

(

)

Remove all content from the config file.

Get()

str Get	(	str	pSectionName,
		str	pItemName,
		str	pDefaultValue = 0
	)

Get an item's value.

Get an item's value by looking inside a specific section of the config file.

Parameters

pSectionName	Name of the section.
pItemName	Name of the item.
pDefaultValue	Default value that will be returned if the item is not found.

Returns

The value assigned to the item in the specified section of the config file, or the default value if not found.

GetOrSet()

bool GetOrSet	(	str	pSectionName,
		str	pItemName,
		str	pValue,
		str	pComment = 0
	)

Get a value from the config file and set it if it was not found.

Parameters

pSectionName	Name of the section.
pItemName	Name of the item.
pValue	Reference the the string that will contain the value of the item. If the item is not found in the file, it will be added with the initial value in this string.
pComment	Optional parameter that can be used to add a comment.

Returns

true if the value was found or added, or false if the item was not found and could not be added to the file.

Set()

bool Set	(	str	pSectionName,
		str	pItemName,
		str	pValue,
		str	pComment = 0
	)

Set an item's value.

Assign a value to an item in the config file. If the item does not exist, it will be created.

Parameters

pSectionName	Name of the section.
pItemName	Name of the item.
pValue	Value assigned to the item.
pComment	Optional parameter that can be used to add a comment.

Returns

true if the item was written to the config file, false otherwise.