LCSession の AddProperty メソッド

このメソッドは新しいプロパティを作成し、プロパティトークンを割り当てます。

定義位置

LCSession クラス

構文

tokenID = lcSession. AddProperty (propertyName, storageType

パラメータ

パラメータ	説明
propertyName	String 型。作成するプロパティの名前。このストレージタイプのプロパティ内で固有の名前を付ける必要があります。既存のプロパティと同じ名前を使用すると、ストレージタイプが違う場合には新しいトークンが作成されますが、ストレージタイプが同じ場合には以前に割り当てられたトークンが返されます。
storageType	Long。オプション。次のいずれかです。 LCPROPSTORE_STATIC -- アクティビティ文書との間で読み取りまたは書き込みが行われます。 LCPROPSTORE_DYNAMIC -- 今回の実行の間だけ存在します。 LCPROPSTORE_SYSTEM -- オペレーティングシステムのシステム環境変数との間で読み取りおよび書き込みが行われます。注: システムプロパティは、実行後まで持続されません。

説明

propertyName

String 型。作成するプロパティの名前。このストレージタイプのプロパティ内で固有の名前を付ける必要があります。既存のプロパティと同じ名前を使用すると、ストレージタイプが違う場合には新しいトークンが作成されますが、ストレージタイプが同じ場合には以前に割り当てられたトークンが返されます。

storageType

Long。オプション。次のいずれかです。

LCPROPSTORE_STATIC -- アクティビティ文書との間で読み取りまたは書き込みが行われます。

LCPROPSTORE_DYNAMIC -- 今回の実行の間だけ存在します。

LCPROPSTORE_SYSTEM -- オペレーティングシステムのシステム環境変数との間で読み取りおよび書き込みが行われます。

注: システムプロパティは、実行後まで持続されません。

戻り値

値	説明
tokenID	Long。プロパティに割り当てられるトークン。トークンは、アクティビティの今回の実行に限り有効です。トークンの値は、アクティビティ自体で定義された最大のトークン値と、ベーストークンの最大値である 65535 の間になります。

注: 追加されたすべてのプロパティは、アクティビティによって定義されたプロパティに追加されます。追加できるプロパティには、3 つのタイプがあります。静的プロパティは、LEI (IBM® Lotus Enterprise Integrator®) Administrator データベース内のアクティビティ文書自体に格納されます。その後同じアクティビティを実行するときには、プロパティの値を取り出すことができます。動的プロパティは、アクティビティの現在の実行についてのみ定義され、アクティビティが終了すると破棄されます。システムプロパティは、オペレーティングシステムの環境変数に代表されます。すべての値の取り出しや割り当てにより、すぐに環境変数の値が変更されます。