Serialises the data referenced by a list of Key string to a XML file.

Very useful under a Grid computing framework because via a single XML file, we can move data across a network and have the objects recreated on another machine.

Or we can simply store objects to disk outside of an Excel spreadsheet environment.

Because the serialised files are XML based, you can store these within a database for storage.

The data file can be read in via the ApplyKeyDataFile() function and thus all the object stored within the file will be recreated in memory.

An optional KeyTag may be required because if we simply stored all the original keys and later (via the ApplyKeyDataFile() function) wanted to recreate the objects that are contained within the KeyFile, some or all of these objects would clash with objects that are currently residing in memory.

This is most likely to happen if one executed KeyToDataFile() and then executed ApplyKeyDataFile() without removing the original objects from memory.

Applying a KeyTag (via the 'KeyTag' parameter) to each object's String-Key (or more rather, the object's string identifier) allows the previous scenario to occur while creating new objects.

This function allows you to a list of string keys via the 'KeyIds' parameter, all of which will have the same KeyTag applied to all the objects.

You can execute the ListKeyDataFile() function in order to view the list of keys that can be applied to memory.

Via the key extension tags you can determine which function(s) were used and are going to be used to create (recreate) the objects.

String CTGridTools.KeyToDataFile( _
String FileName, _
String Path, _
String KeyTag, _
Variant KeyIds)

=CT.GRID.KeyToDataFile(
Excel String Cell FileName,
Excel String Cell Path,
Excel String Cell KeyTag,
XLRange KeyIds)

static std::string KeyToDataFile(
std::string FileName,
std::string Path,
std::string KeyTag,
CTRangeDataCPP KeyIds);

System.String CTGridToolsSA.KeyToDataFile(
System.String FileName,
System.String Path,
System.String KeyTag,
CTRangeData KeyIds);

The C# example below contains all the sub-function calls leading up to this function call. As a result, the example can contain a lot of code.

The VB.NET, J#, C++.NET, Java, Excel VBA, Visual Basic 6 (via COM) and C++ examples below contain function code stubs for the calls leading up to this function call. However, the function call for this function is displayed.
You can easily reproduce the stub functions code from the C# example.