CP_PropertyList.h File Reference

Namespaces
namespace	CP_PropertyList
Functions
Node *	ReadFromFile (const CP_FileSystemSpec &inPropertyListFile, NodeType_t inExpectedNodeType=NodeType_Any)
void	WriteToFile (const Node &inPropertyList, const CP_FileSystemSpec &inTargetFile)

---

Function Documentation

Node * CP_PropertyList::ReadFromFile (  const CP_FileSystemSpec &  inPropertyListFile, NodeType_t  inExpectedNodeType = NodeType_Any )

Read in and parse the passed in property list file. This will open and read in the XML property list document creating the root node specified in the document including all of it's child nodes. Parameters: inPropertyListFile  A CP_FileSystemSpec to the property list file to be parsed. Exceptions: CP_OSErrorException  raised when problems occur while opening, reading or parsing. Returns: A pointer to the root node of the property list.

void CP_PropertyList::WriteToFile (  const Node &  inPropertyList, const CP_FileSystemSpec &  inTargetFile )

Save the specified property list as XML into the target file. If the file exists, it'll be overwritten. Parameters: inPropertyList  The property list (it's root node) to be written. inTargetFile  A CP_FileSystemSpec to the location where the target file should be created. Exceptions: CP_OSErrorException  raised when problems occur while opening, reading or parsing. Returns: void

---