Submit a ticketCall us

AnnouncementsFace your biggest database issues head-on

Our new eCourse helps you navigate SQL Server performance blocks by teaching you how to recognize and deal with the three DBA Disruptors: Performance Hog, Blame Shifter, and Query Blocker. Register today to learn how to defend your environment and fend off menacing disruptions.

Register for your free eCourse.

Home > Success Center > Kiwi CatTools > Kiwi CatTools Documentation > Kiwi CatTools 3.11 Administrator Guide > API > Environments

Environments

Table of contents
No headers
Created by Caroline Juszczak, last modified by Caroline Juszczak on Jun 28, 2016

Views: 249 Votes: 0 Revisions: 1

Due to the capabilities of the CatTools API (i.e. it can directly modify device data in the CatTools database), it is assumed that someone using the API would have a reasonable knowledge of Visual Basic programming skills and therefore would probably be familiar with the Visual Basic development environment, for example Visual Studio; or alternatively knows how to utilize the VBA programming environment (Visual Basic editor) within Microsoft Office applications.

 

This is why the API sample code is written in VB/VBA form.

 

Within these development environments, you simply add a reference* to the CatTools API called "CatTools API" to expose the classes available. ?? Once the reference has been added, you should be able to simply copy and paste the sample code from the CatTools API help pages into your VB project and it will work.

 

However, if you are using a text editor (such as Notepad), you won't be able to add a reference to the CatTools API. For text editors, you need to change the code slightly to use the 'CreateObject' function to reference the CatToolsAPI available classes.

 

For example (within a text editor):

 

Dim DB

Set DB = CreateObject("CatToolsAPI.Database")

 

This would be used to replace the code in the sample code:

 

Dim DB As CatToolsAPI.Database

Set DB = New CatToolsAPI.Database

 

You can then save the text file as a VBScript (.VBS) file and run it.

 

In order for the API code to work, the CatTools API library file (Cattools.dll) must be registered on the system correctly, which you can do using the following from the START (button) > RUN dialog:

 

regsvr32 "C:\Windows\system32\cattools.dll"

 

* Adding a reference (within a VB editor):

  • For the Visual Basic editor within Microsoft Office applications, click the Tools > References... menu item and select the "CatTools API" from the available references.
  • For the VB6 IDE, click the Project > References... menu item and select the "CatTools API" from the available references.

 

 
Last modified

Tags

Classifications

Public