ReadXML




http://www.QuantTools.com
CapeTools Utils function list

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

Key TAGs | Excel Index | API Index


Reads a XML file into memory.

You can then use the XMLGenericQuery() function to apply XPath queries against the loaded document.



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 : "XMLDoc"



Note: Within Excel, the function is named - CT.XML.ReadXML


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



Parameter Description


  1. Key parameter

    Key value to use as a handle for the created object
  2. Reload parameter

    When creating this object for the first time, set this parameter to a positive value. Within Excel, when re-computing a worksheet where you do not wish to recreate the object, set this parameter to zero (0).
  3. FileName parameter

    Name of the file to read into memory (can include path).
  4. Path parameter

    Optional directory path. Will be pre-pended to the FileName parameter.


Extended information

Function Syntax

VB Syntax 


String CTUtils.ReadXML( _
String Key, _
Long Reload, _
String FileName, _
String Path)


Excel Spreadsheet Syntax 


=CT.XML.ReadXML(
Excel String Cell Key,
Excel Numeric Cell Reload,
Excel String Cell FileName,
Excel String Cell Path)


C++ Syntax 


static std::string ReadXML(
std::string Key,
long Reload,
std::string FileName,
std::string Path);


DotNET Syntax 


System.String CTUtilsSA.ReadXML(
System.String Key,
System.Int32 Reload,
System.String FileName,
System.String Path);

Parameter data types

ArgNameArgTypeIsKey
KeyStringFALSE
ReloadLongFALSE
FileNameStringFALSE
PathStringFALSE

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
KeyFALSEMyReadXML
ReloadFALSE1
FileNameFALSEird_ex01_vanilla_swap.xml
PathTRUEE:\CapeTools\cpp.v6\CTFpML41\Examples\ird


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