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

Defined in

NotesSession

Syntax

value$ = notesSession.GetEnvironmentString( 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.

value$

String. The value of the environment variable.

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 (see "Restricting agents on servers" in Administration Help or Administering the Domino System).

Language cross-reference

getEnvironmentString method in Java Session class

@Environment in formula language

ENVIRONMENT keyword in formula language

Example
See Also

GetEnvironmentValue method
SetEnvironmentVar method
Using environment variables

Glossary