ViewFXList





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

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

Key TAGs | Excel Index | API Index



Returns a range object presenting all the FX rates present within the FXRate object.

The FX object that this function will be based on must have been previously created via one of the following functions : CreateFXManager(), CreateFX() or CreateFXChain(). This function would have returned a string 'KEY' which is to be passed to the 'FXKey' parameter within this function.



Note: Within Excel, the function is named - CT.FX.ViewFXList




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



Parameter Description


  1. FXKey parameter

    Key to an already constructed FX (exchange rate) object (or fx manager object).


Extended information

Function Syntax

VB Syntax


Variant CTCurrency.ViewFXList( _
String FXKey)


Excel Spreadsheet Syntax


=CT.FX.ViewFXList(
Excel String Cell FXKey)


C++ Syntax


static CTRangeDataCPP ViewFXList(
std::string FXKey);


DotNET Syntax


CTRangeData CTCurrencySA.ViewFXList(
System.String FXKey);

Parameter data types

ArgNameArgTypeIsKey
FXKeyStringTRUE


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
FXKeyFALSEFXKeyNAME.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.Curves20 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 ViewFXList() 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 ViewFXList() function call


Example
EURATS13.7603
EURBEF40.3399
DKKGBP35.35
EURFIM5.94573
EURFRF6.55957
EURDEM1.95583
EURGRD340.75
EURIEP0.787564
EURITL1936.27
JPYGBP100.5
EURLUF40.3399
EURNLG2.20371
EURPTE200.482
RONROL10000
EURESP166.386
EURCHF1.6
TRYTRL1e+006
EURGBP1.56
EURUSD1.3



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