ReadXLRange3





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

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

Key TAGs | Excel Index | API Index



Reads a range object from an XML file that contains several serialised range objects (Up to 7 range objects) written previously via the function WriteXLRange3(). You specify the range object you wish to read via a named tag.

Tag names were defined during the call of the WriteXLRange3() function, thus you must know the value of the named tags.



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




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



Parameter Description


  1. FileName parameter

    Name of the file to write to (can include path).
  2. Path parameter

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

    Index parameter to locate which range you wish to view. Starts from 1.


Extended information

Function Syntax

VB Syntax


Variant CTQueryDB.ReadXLRange3( _
String FileName, _
String Path, _
String szTagName)


Excel Spreadsheet Syntax


=CT.XML.ReadXLRange3(
Excel String Cell FileName,
Excel String Cell Path,
Excel String Cell szTagName)


C++ Syntax


static CTRangeDataCPP ReadXLRange3(
std::string FileName,
std::string Path,
std::string szTagName);


DotNET Syntax


CTRangeData CTQueryDBSA.ReadXLRange3(
System.String FileName,
System.String Path,
System.String szTagName);

Parameter data types

ArgNameArgTypeIsKey
FileNameStringFALSE
PathStringFALSE
szTagNameStringFALSE


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
FileNameFALSEMyXLData3
PathTRUEC:\
szTagNameFALSEYieldCurveData


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 ReadXLRange3() 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

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


Example
1Y5
2Y5.01
3Y5.02
4Y5.03
5Y5.04
7Y5.05
10Y5.06



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