UserProperty プロパティ

これは共通のメソッドです。プラットフォーム固有の実装上の制限がある場合は、このメソッドを使用するオブジェクトのトピックに記載されています。

このプロパティを使用すると、ユーザー定義の任意の情報をオブジェクトに関連付けることができます。この情報は VARIANT として渡され、格納できるのは単純な型 (String、整数型) のみです。SAFEARRAY 型や VARIANT 型をこの 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 関数の標準の戻り値を返します。

​

備考

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

このプロパティは、次のオブジェクトで提供されます。

• BaseLanguage
• Block
• Layout
• TextLanguage

​

関連項目

Properties の操作