メインコンテンツへスキップ
これは共通のメソッドです。プラットフォーム固有の実装上の制限については、このメソッドを使用するオブジェクトのトピックに記載されています。
このプロパティを使用すると、ユーザー定義の任意の情報をオブジェクトに関連付けることができます。この情報は 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” のように、他のプロパティと区別して識別するための任意の string 値を指定します。 result [out, retval] ユーザー定義プロパティの値を受け取る VARIANT 変数へのポインターです。 value [in] この VARIANT 変数には、プロパティの新しい値が含まれます。

​
戻り値

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

​
備考

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

​
関連項目

プロパティの操作