setEnvironmentVar (Session - Java™)

文字列または数値の環境変数の値を設定します。

定義位置

Session

構文

public void setEnvironmentVar(String vname, Object value)
    throws NotesException
public void setEnvironmentVar(String vname, Object value, boolean issystem)
    throws NotesException

パラメータ

String vname

設定する環境変数の名前です。

Object value

環境変数の値。日時の値は文字列に変換されます。

boolean issystem

true の場合、変数名の先頭にドル記号 (「$」) は追加されません。このパラメータが false の場合か省略された場合、ドル記号が変数名の先頭に追加されます。

使用法

vname という環境変数がすでに存在する場合は、その変数に新規の値が割り当てられます。これ以外の場合は、新しい環境変数が NOTES.INI ファイルまたは Notes プリファレンスファイルに追加されます。

SetEnvironmentVar はドル記号 ($) を名前の前に付加してから環境変数の値を設定します。これは、issystem を true に指定するか、あらかじめ名前の先頭文字として「$」を含めている場合を除きます。NOTES.INI (または Notes プリファレンス) ファイルの環境変数を調べると、「$」文字を確認できます。getEnvironmentString メソッドや getEnvironmentValue メソッドを使用して環境変数を取得する場合、環境変数名に「$」を付けるかどうかを選択できます。

環境変数は現在のセッションの notes.ini ファイルに設定されます。

クロスリファレンス

LotusScript® NotesSession クラスの SetEnvironmentVar メソッド

式言語の @SetEnvironment 関数

式言語の @Environment 関数

式言語の ENVIRONMENT キーワード