Serialises the data referenced by a list of Key string to a static memory location.

This is useful under the scenario of taking static snapshot of objects within memory.

You can execute this function, continue to update the external objects and then apply the original objects recorded by this function back into memory under new object key-names and thus you do not erase the updated objects.

Very useful under a scenario analysis where you are comparing the results of an original set of objects to another updated set of objects.

You can also execute the KeyToDataFile() function to save these objects to a file.

The data string can be applied to memory via the ApplyKeyDataID() function and thus all the object stored within this ID will be recreated in memory.

An optional KeyTag may be required because if we simply stored all the original keys and later (via the ApplyKeyDataID() function) wanted to recreate the objects that are contained within the ID, 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 KeyToDataID() and then executed ApplyKeyDataID() 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 ListKeyDataID() 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.

This function creates an object and returns a string-key value to represent this created object.
The TAG value of the string-key returned (second part of the key) is : "KEYDATA"

String CTGridTools.KeyToDataID( _
String Key, _
Long Reload, _
String KeyTag, _
Variant KeyIds)

=CT.GRID.KeyToDataID(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel String Cell KeyTag,
XLRange KeyIds)

static std::string KeyToDataID(
std::string Key,
long Reload,
std::string KeyTag,
CTRangeDataCPP KeyIds);

System.String CTGridToolsSA.KeyToDataID(
System.String Key,
System.Int32 Reload,
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.