式に保存されている環境変数を設定するか、返します。

構文

@Environment( variable )
@Environment( variable ; value )

パラメータ

variable

文字列または文字列リスト。取り出したい環境変数の名前を指定します。複数の環境変数を取り出すには、文字列リストを使用します。

文字列。省略可能。環境変数に割り当てる値を指定します。ユーザーは独自の notes.ini ファイルや Lotus Notes のプリファレンスファイルを持っているため、この値はユーザーごとに設定できます。値を取り出すだけで設定はしないときは、このパラメータは省略します。
• variable が文字列リストのとき、リスト内のすべての環境変数に value が割り当てられます。
• value が文字列リストのとき、リストの最初の値だけが使用され、残りは無視されます。

environmentVariable

文字列。指定した環境変数の値が返されます。戻り値を計算に使用するには、@TextToNumber を使用してこの文字列を数値に変換します。

式内で環境変数を設定したいときに @Environment を使用します。@If や @Do など他の @関数内にネストするときは、この関数ではなく @SetEnvironment を使用します。

ENVIRONMENT キーワードは @Environment と同じように機能します。

@Environment は、列式や選択式では使用できません。フィールド式、ツールバーボタン、エージェントで使用します。スケジュールが設定されているエージェントなど、一部の式はユーザーのクライアント上ではなくサーバー上で実行されます。この場合、式の対象となる環境変数は、クライアントではなくサーバーの環境変数です。計算結果の文字列式を使用して変数を取得できますが、変数を設定することはできません。

@Environment を使用して、ユーザーの notes.ini ファイル (Windows、OS/2、UNIX) または Lotus Notes のプリファレンスファイル (Macintosh) に保存されている環境変数の値を取得することもできます。値を設定および取得できるのは、ドル記号 ($) で始まっている変数のみです。変数パラメータの一部にドル記号を使用することはできません。たとえば、INI 変数 $EnableAlarms の値を 1 から 0 に変更するには、次のように入力します。

@Environment("EnableAlarms";"0")

Web アプリケーションでは、Web ユーザーの環境についての情報を取得するには、事前定義のフィールド名を使用して CGI (コモンゲートウェイインターフェース) 環境変数を要求します。

クロスリファレンス

LotusScript 言語の Environ 関数

LotusScript NotesSession クラスの GetEnvironmentString メソッド

LotusScript NotesSession クラスの SetEnvironmentVar メソッド

Java Session クラスの getEnvironmentString メソッド

Java Session クラスの setEnvironmentVar メソッド

例
関連項目

環境変数を取得および設定する
ENVIRONMENT
@SetEnvironment
ECL セキュリティを伴う @関数

用語集