Given the name of a numeric environment variable, retrieves its value.

Defined in

NotesSession

Syntax

valueV = notesSession.GetEnvironmentValue( name$ [, system ] )

Parameters

name$

String. The name of the environment variable to get.

Boolean. Optional. If True, the method uses the exact name$ of the environment variable. If False, the method prepends "$" to the name$ before retrieving its value. If you omit this parameter, it defaults to False.

valueV

Variant. The value of the environment variable.

User must be listed in the server document/agent manager section in order to access environment variables (notes.ini file) through LotusScript or Java.

If the script runs on a workstation, this method retrieves the environment variable from the current user's notes.ini (or Notes Preferences) file. If the script runs on a server, this method retrieves the environment variable from the server's notes.ini file, subject to administrative restrictions. For more information, see "Restricting agents on servers" in Administration Help or Administering the Domino System.

Language cross-reference

getEnvironmentValue method in Java Session class

Example
See Also

GetEnvironmentString method
SetEnvironmentVar method
Using environment variables

Glossary