LotusScript for Visual Basic Programmers - IBM Redbooks

Accessing Notes Session Environment Values
Using GetEnvironmentString, SetEnvironmentVar and
GetEnvironmentValue, we can access Notes session environment values.
The GetEnvironmentValue, GetEnvironmentString, and SetEnvironmentVar
methods retrieve and set environment variables, which are stored in the
local NOTES.INI or Preferences file. Use GetEnvironmentValue only for
numeric environment variables. Use GetEnvironmentString for strings and
numeric values.
SetEnvironmentVar prepends a dollar sign ($) to argument 1, the name of
the environment variable. This forces a distinction between user
environment variables (name starts with a dollar sign) and system
environment variables (name does not start with a dollar sign).
GetEnvironmentValue and GetEnvironmentString prepend a dollar sign if
the second argument is false or omitted, and do not prepend a dollar sign if
the second argument is true. This permits you to examine system
environment variables as well as user ones.
Environment variables are useful for saving state and data between Notes
sessions on a single server or workstations where no conflicts are possible.
They are also useful for obtaining the environment information set by
Notes, such as KitType, Directory, Preferences, Domain, Port, and so on.
Let’s look at an example.
Example
The following example shows how to set a Notes environment value in
NOTES.INI.
Dim session As Object
Set session = CreateObject("notes.notessession")
Call session.SetEnvironmentVar("TestOfAPI", "IT WORKS")
Set session = Nothing
Following is an explanation of the code.
We use the SetEnvironmentVar method of SessionObject to set the
environment variable.
Call session.SetEnvironmentVar("TestOfAPI", "IT WORKS")
Chapter 6: Accessing Notes Sessions 119