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

定義位置

NotesSession

構文

Call notesSession.SetEnvironmentVar( name$, valueV [, issystemvar ] )

パラメータ

name$

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

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

Boolean 型。省略可能。True の場合、変数名の先頭にドル記号 ($) は付きません。デフォルトは False です。

ユーザーは、制約なしの LotusScript または Java エージェントを実行できるユーザーのリストに明示的に記載されたメンバー、またはグループのメンバーでなければなりません。このリストは、サーバーのアドレス帳に含まれるサーバー文書の [セキュリティ] タブにあります。

環境変数 name$ がすでにある場合は、その変数は新しい値に設定されます。これ以外の場合は、新しい環境変数が notes.ini ファイルまたは Lotus Notes プリファレンスファイルに追加されます。

SetEnvironmentVar はドル記号 ($) を name$ の前に付けてから環境変数の値を設定します。ただし、issystemvar に True を指定するか、すでに name$ の先頭文字が $ のときは $ をつけません。notes.ini ファイルまたは Lotus Notes プリファレンスファイルの環境変数を調べると、$ を含むものがあります。GetEnvironmentString または GetEnvironmentValue メソッドで環境変数を取得するとき、変数名に $ を含めるかどうかを選択できます。

スクリプトがクライアントで実行されるときは、ユーザーの環境変数が設定されます。スクリプトがサーバーで実行されるときは、システム管理の制約が許せば、サーバーの環境変数が設定されます。詳しくは、『Lotus Domino Administrator 7 ヘルプ』または『Lotus Domino システム管理』の「サーバーエージェントを制限する」を参照してください。

エラー

valueV のデータ型が正しくないときは、SetEnvironmentVar は「環境変数には文字列、日付、整数のどれかを指定してください」というエラーを発生させます。

クロスリファレンス

Java Session クラスの setEnvironmentVar メソッド

式言語の ENVIRONMENT キーワード

式言語の @Environment 関数

式言語の @SetEnvironment 関数

例
関連項目

GetEnvironmentString メソッド
GetEnvironmentValue メソッド
環境変数を使用する

用語集