Recreates the objects contained within an XML KeyData ID (that was previously created via the
KeyToDataID() function) to memory.
This function returns a list of string-keys pointing to all of the recreated objects.
If any of the string-keys clashes with objects already residing in memory then none of the objects will be applied and an error will be returned.
You can utilise the 'KeyTagEx' parameter to further provide unique key names.
The
KeyToDataID() function provides a 'KeyTag' parameter in order to prepend all the original string-key names with a tag in order to recreate the objects under new names (if one so wishes).
However under the scenario that the 'KeyTag' was left blank, or even after using the 'KeyTag' parameter, one still will have duplicate key-string names, you can use the 'KeyTagEX' parameter within this function to provide a tag name that will be prepended to all string-keys before being applied to memory.
You can view the list of string-keys before applying the objects to memory via the
ListKeyDataID() function.
However the new key names are quite simple to deduce (if the 'KeyTagEX' parameter is not used).
If you already know the names of the original objects passed into the
KeyToDataID() function, then the new key names are simply the same names prepended by a KeyTag value which was passed to the 'KeyTag' parameter within the same
KeyToDataID() function.
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.
Copyright (c) 2003-2007 CapeTools - All Rights Reserved.