ListKeyDataXML





http://www.QuantTools.com
CapeTools Grid Computing Tools function list

Welcome | Documentation format | QuantTools Groups | QuantTools Categories | Licence

Key TAGs | Excel Index | API Index



Lists the objects contained within an XML KeyData string (that was previously created via the KeyToDataXML() function).

If you were to execute the ApplyKeyDataXML() function, the string-keys from the list of objects that would be created in memory would be the same as the return values from this function.

However the new key names are quite simple to deduce.

If you already know the names of the original objects passed into the KeyToDataXML() function, then the new key names are simply the same names prepended by a KeyTag value which was passed to the 'KeyTag' parameter of the same KeyToDataXML() function.



Note: Within Excel, the function is named - CT.GRID.ListKeyDataXML




High level graphic of ListKeyDataXML() function with parameters. Blue square node is the actual function with the parameters ordered.



Parameter Description


  1. XMLString parameter

    An XML string representing saved object data.


Extended information

Function Syntax

VB Syntax


Variant CTGridTools.ListKeyDataXML( _
String XMLString)


Excel Spreadsheet Syntax


=CT.GRID.ListKeyDataXML(
Excel String Cell XMLString)


C++ Syntax


static CTRangeDataCPP ListKeyDataXML(
std::string XMLString);


DotNET Syntax


CTRangeData CTGridToolsSA.ListKeyDataXML(
System.String XMLString);

Parameter data types

ArgNameArgTypeIsKey
XMLStringStringFALSE


Example Inputs

The first column represents the name of the parameters. The second column specifies whether the parameters are optional or not. Finally the last column provides some sample input data.
Function call input string-keys are always in the format : "NAME.EXTTAG.TICKER" The "EXTTAG.TICKER" part is determined from the output of other, capetools, object creation functions.


ArgNameIsOptional (Excel only)Example
XMLStringFALSEEMPTY


Example function usage


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.


If you are accessing this functrion via the MiniXL libraries, this function is present within the CT.QL.Utils20 MiniXL Excel Addin.

Within our Excel Example Addin Generator, we have used the following QuantTools sub-functions in order to prepare the arguments needed to call the ListKeyDataXML() function. If you are executing this function via the MiniXL libraries, the module addin name, (in brackets, to the right of the sub-functions listed below), indicates the MiniXL library in which the sub-function is held. You will need to load this library into your Excel session (along with any other libraries that the sub-function call within the addin requires (ie - CT.QT.Utils20 addin in almost all cases) in order for the example to compute successfully.


The following four examples demostrate calling this function within a Microsoft .NET environment

The following four examples demostrate calling this function within a non .NET environment

Copyright (c) 2003-2007 CapeTools - All Rights Reserved.