メインコンテンツへスキップ
これは共通のメソッドです。プラットフォーム固有の実装上の制限がある場合は、このメソッドを使用するオブジェクトのトピックに記載されています。
このプロパティを使用すると、ユーザー定義の任意の情報をオブジェクトに関連付けることができます。この情報は VARIANT として渡されますが、格納できるのは単純型 (String、整数型) のみで、この VARIANT 内に SAFEARRAY 型または VARIANT 型を含めることはできません。より正確には、使用できる variant 型は次のとおりです: VT_EMPTY, VT_UI1, VT_I2, VT_I4, VT_R4, VT_R8, VT_CY, VT_BSTR, VT_NULL, VT_ERROR, VT_BOOL, VT_DATE。

​
構文

​
C++

HRESULT get_UserProperty(
   BSTR     name,
   VARIANT* result
);
HRESULT put_UserProperty(
   BSTR    name,
   VARIANT value
);

​
C#

object get_UserProperty( string name );
void set_UserProperty(
   string name,
   object value
);

​
Visual Basic .NET

Property UserProperty(name As String) As Object

​
パラメーター

name [in] この変数には、たとえば “MyProperty” のように、他のプロパティと区別してこのプロパティを識別するための任意の文字列値が入ります。 result [out, retval] ユーザー定義プロパティの値を受け取る VARIANT 変数へのポインターです。 value [in] この VARIANT 変数には、プロパティの新しい値が入ります。

​
戻り値

このプロパティに固有の戻り値はありません。代わりに、ABBYY FineReader Engine 関数の標準戻り値が返されます。

​
備考

プロパティは名前で識別されます。したがって、1 つのオブジェクトに対して、同じ名前のプロパティを複数持つことはできません。オブジェクトに指定した名前のユーザープロパティがない場合、そのプロパティに初めて値が設定された時点で作成されます。オブジェクトに存在しないプロパティの値を取得しようとすると、空の VARIANT が返されます。CopyFrom メソッドでオブジェクトをコピーすると、ユーザー定義プロパティもコピーされます。オブジェクトが永続化される場合、ユーザー定義プロパティも永続化されます。 このプロパティを提供するオブジェクトは次のとおりです。

​
関連項目

プロパティ の使用