Overview

serialization.

Function List

ohObjectLoad ()
ohObjectLoadString ()
ohObjectSave ()
ohObjectSaveString ()

Function Documentation

ohObjectLoad

vector<string> returnValue
 
ohObjectLoad(
        string Directory
        string Pattern
        bool Recurse
        bool Overwrite
        any Trigger)

Description:

Deserialize list of objects from given file, return IDs of deserialized objects.

Supported Platforms:

Excel, C++, Calc

Parameters

Directory	Directory from which objects are to be deserialized.
Pattern	Name of XML file from which objects are to be deserialized, or a pattern in UNIX format (wildcard is .). Default value = .\.xml.
Recurse	Recurse subdirectories of Directory when searching for filenames matching Pattern. Default value = false.
Overwrite	Overwrite any existing Object that has the same ID as one being loaded. Default value = false.
Trigger	dependency tracking trigger

ohObjectLoadString

vector<string> returnValue
 
ohObjectLoadString(
        string Xml
        bool Overwrite
        any Trigger)

Description:

Deserialize list of objects from given string, return IDs of deserialized objects.

Supported Platforms:

Excel, C++

Parameters

Xml	XML string from which objects are to be deserialized.
Overwrite	Overwrite any existing Object that has the same ID as one being loaded. Default value = false.
Trigger	dependency tracking trigger

ohObjectSave

long returnValue
 
ohObjectSave(
        vector<string> ObjectList
        string Filename
        bool Overwrite
        bool IncludeGroups
        any Trigger)

Description:

Serialize list of objects to given path, return count of objects serialized.

Supported Platforms:

Excel, C++, Calc

Parameters

ObjectList	list of IDs of objects to be serialized.
Filename	file name to which objects are to be serialized.
Overwrite	overwrite the output file if it exists. Default value = false.
IncludeGroups	include Groups in the serialisation. Default value = true.
Trigger	dependency tracking trigger

ohObjectSaveString

string returnValue
 
ohObjectSaveString(
        vector<string> ObjectList
        bool Overwrite
        any Trigger)

Description:

Serialize list of objects to given path, return resulting XML.

Supported Platforms:

Excel, C++

Parameters

ObjectList	list of IDs of objects to be serialized.
Overwrite	overwrite the output file if it exists. Default value = false.
Trigger	dependency tracking trigger