ListKeyDataID





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 ID (that was previously created via the KeyToDataID() function).

If you were to execute the ApplyKeyDataID() 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 KeyToDataID() 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 KeyToDataID() function.



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




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



Parameter Description


  1. KeyID parameter

    Pointer to a KeyID.


Extended information

Function Syntax

VB Syntax


Variant CTGridTools.ListKeyDataID( _
String KeyID)


Excel Spreadsheet Syntax


=CT.GRID.ListKeyDataID(
Excel String Cell KeyID)


C++ Syntax


static CTRangeDataCPP ListKeyDataID(
std::string KeyID);


DotNET Syntax


CTRangeData CTGridToolsSA.ListKeyDataID(
System.String KeyID);

Parameter data types

ArgNameArgTypeIsKey
KeyIDStringTRUE


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
KeyIDFALSEKeyIDNAME.EXTTAG.TICKER (from a function call)


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 ListKeyDataID() 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.

These are the financial QuantTools sub-function calls that are used within the examples :





The objects generated by these sub-functions are inter-connected in the following way :




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

The following is a sample output from executing the ListKeyDataID() function call


Example
OBJ1#MyCALUKExchange_2.ukexchange
OBJ1#MyEuroCal_2.euro
OBJ1#MyDepoTPL_2.DepoTPL
OBJ1#MySwapTPL_2.SwapTPL
OBJ1#MyValuationDate_2.VALDTE
OBJ1#MyYC_XCCY_DCF_2.MYCX_D
OBJ1#MySchedule_2.MSCH
OBJ1#MyCreateAmortObj_2.AMORT
OBJ1#MyMiniYC_2.MYC_D
OBJ1#MyNewIndex2_2.IDX
OBJ1#MySABRVolCurve_2.SABRVC
OBJ1#MyMarket4_2.MKT
OBJ1#MyCreateAmortFloatLeg2_2.AFLTLEG



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