LotusScript for Visual Basic Programmers - IBM Redbooks

Chapter 6
Accessing Notes Sessions
Notes sessions provide access to environment variables and address books,
and they provide information on the current user, Notes platform and
Notes release number.
In this chapter, we will discuss how to access Notes sessions:
In HiTest
Using Notes classes through OLE automation in Visual Basic
Using LotusScript in Notes.
Accessing Notes Sessions Using the HiTest Basic API
Session class functions are global within a HiTest API session (one
processor task). These functions have no context beneath the implicit
session context — that is, no functions in other classes affect their
operation — and they are always usable, after calling HTInit.
Every HiTest API program must initialize and terminate the HiTest API.
Unless you call the HiTest API initialization function HTInit to establish a
session, all other functions will fail. Additionally, every HiTest API
program must call the HTTerm function after all HiTest API function calls
are complete and before the program terminates. It is crucial to call the
termination function to avoid leaving the system in a dangerous state.
The single exception to these restrictions is the HTGetAPILibraryVersion
function, which may be used before initialization to check the HiTest
API DLL version code and string. The version of the HiTest API with
which a program was created can be obtained with the constants
HTVERSION_LIBRARY for the version code and
HTVERSION_LIBRARY_STRING for the version string.
For detailed information on the Notes session functions, refer to the online
help information for the HiTest Tools Visual Basic API.
Let’s look at some of the functions.
113