DeleteObject




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

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

Key TAGs | Excel Index | API Index


Given ANY 'KEY' string value generated by a CapeTool function, you can request for the object to be marked for deletion from memory.

If no other object within the library holds a reference to this object, the object will be deleted immediately.

If however the object marked for deletion is referenced by other objects, the object will be deleted when all other objects that refer to this marked-for-deletion object are deleted as well.



Note: Within Excel, the function is named - CT.DB.DeleteObject


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



Parameter Description


  1. Key parameter

    The KEY generated by a CapeTools function.


Extended information

Function Syntax

VB Syntax 


String CTQueryDB.DeleteObject( _
String Key)


Excel Spreadsheet Syntax 


=CT.DB.DeleteObject(
Excel String Cell Key)


C++ Syntax 


static std::string DeleteObject(
std::string Key);


DotNET Syntax 


System.String CTQueryDBSA.DeleteObject(
System.String Key);

Parameter data types

ArgNameArgTypeIsKey
KeyStringTRUE

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
KeyFALSEKeyNAME.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 DeleteObject() 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 DeleteObject() function call


Deleted

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