UserProperty プロパティ

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

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

​

備考

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

このプロパティは、次のオブジェクトで使用できます。

• BaseLanguage
• Block
• Layout
• TextLanguage

​

関連項目

プロパティの操作