Sets an environment variable stored in the user's notes.ini file (Windows, OS/2, and UNIX) or Notes Preferences file (Macintosh).

Syntax

@SetEnvironment( variableName ; value )

Parameters

variableName

Text. The name of the environment variable, enclosed in quotation marks. If you enter a text list for the variableName, then every variable named in that list receives the specified value. If you store the field name in a variable, omit the quotation marks here.

Text. The value you want to give to variableName. If you use a text list for value, only the first value in the list is used; the rest are ignored.

Use @SetEnvironment when you want to set an environment variable from within another @function (such as @If or @Do). To set the environment variable outside of an @function, use @Environment or the ENVIRONMENT keyword.

@SetEnvironment cannot be used in column or selection formulas. Some formulas, such as scheduled agents, are run on the server instead of the user's workstation. In this case, the environment variables affected are the server's environment variables, not the workstation's.

To get the value of an environment variable, use @Environment.

You cannot use this function in Web applications. However, in Web applications, you can use predefined field names to gather information about the Web user's environment by requesting Common Gateway Interface (CGI) environment variables.

This function prepends a dollar sign ($) to the variable name when it stores the variable in the notes.ini (or Notes Preference) file. Use the SetEnvironmentVar method of the LotusScript NotesSession class or the setEnvironmentVar method of the Java Session class if you want to create a variable without the prepended dollar sign.

Language cross-reference

SetEnvironmentVar method of LotusScript NotesSession class

setEnvironmentVar method of Java Session class

Example
See Also

@Environment
ENVIRONMENT
Getting and setting environment variables
@Functions with ECL security
"Create your own formula debugger" on Tips from the Lotus Developer Domain
"Integrating Java applets into Notes" on the Lotus Developer Domain
"Adding a friendly ad-hoc query tool to Domino applications" on the Lotus Developer Domain

Glossary