IBM Lotus Domino Designer 8.5
  Versions 8.5 and 8.5.1

getEnvironmentString method

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

Defined in

Session

Syntax

public String getEnvironmentString(String vname)

    throws NotesException

public String getEnvironmentString(String vname, boolean issystem)

    throws NotesException

Parameters

String vname

The name of the environment variable to get.

boolean issystem

If true, the method uses the exact name of the environment variable. If false or omitted, the method prepends "$" to the name before retrieving its value.

Return value

String

The value of the environment variable.

Usage

This method retrieves the environment variable from the NOTES.INI file for the current session.

Language cross-reference

GetEnvironmentString method in LotusScript NotesSession class

@Environment function in formula language

ENVIRONMENT keyword in formula language

See examples

---

Library | Support | Terms of use |

Last updated: Monday, October 5, 2009