ReadXLRange2





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 multiple range objects (Up to 15 range objects) written via the function WriteXLRange2(). You specify the range object you wish to read via an index number.

The function returns the queried range object.

This function is useful, for example from an Excel environment, if you wish to read several range object that have been stored within ONE xml file independently from a spreadsheet.

XML files can be saved to a central location where other users can also read these ranges back in via the ReadXLRange2() function.

The ReadXLRange2() function simply uses the an index number (1-based) to locate the range you wish to extract.

The index number used depends on the order in which range objects were passed to the WriteXLRange2() function.

The first range passed in takes on index number 1, the second range, index number 2 etc... You must pass in a range object for the first parameter, but all other parameters are optional (or null objects if using the API functions).

You can also pass in range objects just for parameter 1 and 7 only, thus the indexes used during the reading of these ranges will be 1 and 7 respectively within the ReadXLRange2() function.



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




High level graphic of ReadXLRange2() 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. nIndex parameter

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


Extended information

Function Syntax

VB Syntax


Variant CTQueryDB.ReadXLRange2( _
String FileName, _
String Path, _
Long nIndex)


Excel Spreadsheet Syntax


=CT.XML.ReadXLRange2(
Excel String Cell FileName,
Excel String Cell Path,
Excel Numeric Cell nIndex)


C++ Syntax


static CTRangeDataCPP ReadXLRange2(
std::string FileName,
std::string Path,
long nIndex);


DotNET Syntax


CTRangeData CTQueryDBSA.ReadXLRange2(
System.String FileName,
System.String Path,
System.Int32 nIndex);

Parameter data types

ArgNameArgTypeIsKey
FileNameStringFALSE
PathStringFALSE
nIndexLongFALSE


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
FileNameFALSEMyXLData2
PathTRUEC:\
nIndexFALSE1


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 ReadXLRange2() 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 ReadXLRange2() function call


Example
17
28
39
410
511
612



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