Define o da como resultado una variable de entorno almacenada en una fórmula.

Sintaxis

@Environment( variable )
@Environment( variable ; valor )

Parámetros

variable

Texto o lista de texto. El nombre de la variable de entorno que se desea recuperar. Para recuperar varias variables de entorno, utilice una lista de texto.

Texto. Opcional. El valor que se desea asignar a la variable de entorno. Dado que cada usuario tiene su propio archivo notes.ini o Notes Preferences, este valor puede personalizarse para cada uno de ellos. Si desea recuperar el valor, no definirlo, omita este parámetro.
• Si variable es una lista de texto, a cada una de las variables se le asignará el valor especificado.
• Si valor es una lista de texto, la función sólo empleará el primero de los valores; el resto serán ignorados.

variable-entorno

Texto. El valor actual de la variable de entorno especificada. Si desea utilizar el resultado en operaciones aritméticas, utilice @TextToNumber para convertirlo en un número.

Use @Environment cuando desee definir una variable de entorno dentro de una fórmula. Si piensa anidarla dentro de otra función @ (como @If o @Do), use @SetEnvironment en su lugar.

La palabra clave ENVIRONMENT funciona del mismo modo que @Environment.

@Environment no puede emplearse en fórmulas de columna ni de selección; su uso solamente es aconsejable en fórmulas de campo, de botón, de SmartIcon y de agente. Algunas fórmulas, como las de los agentes programados, se ejecutan en el servidor en lugar de hacerlo en la estación de trabajo. En este caso, las variables de entorno afectadas son las del servidor, no las de la estación de trabajo. También se puede usar una fórmula de texto calculado para recuperar variables, pero no para definirlas.

También se puede usar @Environment para obtener el valor de una variable de entorno almacenada en el archivo notes.ini (Windows, OS/2 y UNIX) Notes Preferences (Macintosh) del usuario. Sólo es posible definir y recuperar los valores de variables que comienzan por el signo de dólar ($). No incluya el signo de dólar en el parámetro de la variable. Por ejemplo, para cambiar el valor de la variable inicial $EnableAlarms de 1 a 0, introduzca:

@Environment("EnableAlarms";"0")

En las aplicaciones para Web, utilice nombres de campo predefinidos para recopilar información sobre el entorno del usuario de Web; para ello, solicite las variables de entorno de CGI (del inglés Common Gateway Interface, interfaz común de gateway).

Equivalencias en otros lenguajes

Función Environ del lenguaje LotusScript

Método GetEnvironmentString de la clase NotesSession de LotusScript

Método SetEnvironmentVar de la clase NotesSession de LotusScript

Método getEnvironmentString de la clase Session de Java

Método setEnvironmentVar de la clase Session de Java

Ejemplo
Véase también

Getting and setting environment variables
ENVIRONMENT
@SetEnvironment
Funciones @ afectadas por la Lista de control de ejecución
"Create your own formula debugger" en Tips de Lotus Developer Domain