getEnvironmentString (NotesSession - JavaScript™)

Gets the value of a string environment variable.

Defined in

NotesSession

Syntax

getEnvironmentString(vname:string) : string

getEnvironmentString(vname:string, issystem:boolean) : string

Parameter Description
vname The name of the environment variable.
issystem If true, the method uses the exact name of the environment variable. If false or omitted, the method prefixes a dollar sign to the name.
Return value Description
String The value of the environment variable.

Examples

This computed field displays the value of a non-system environment variable.
var v = session.getEnvironmentString("HomeTown");
if(v == "") {
	return "No home town"
} else {
	return v
}