> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# UserProperty プロパティ

> ABBYY FineReader Engine API の UserProperty プロパティ — ユーザー定義の VARIANT 情報をオブジェクトに関連付ける共通プロパティ。

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

このプロパティを使用すると、ユーザー定義の任意の情報をオブジェクトに関連付けることができます。この情報は 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。

<div id="syntax">
  ## 構文
</div>

<div id="c">
  ### C++
</div>

```cpp theme={null}
HRESULT get_UserProperty(
   BSTR     name,
   VARIANT* result
);
HRESULT put_UserProperty(
   BSTR    name,
   VARIANT value
);
```

### C\#

```csharp theme={null}
object get_UserProperty( string name );
void set_UserProperty(
   string name,
   object value
);
```

<div id="visual-basic-net">
  ### Visual Basic .NET
</div>

```vb theme={null}
Property UserProperty(name As String) As Object
```

<div id="parameters">
  ## パラメーター
</div>

name

\[in] この変数には、たとえば "MyProperty" のように、ほかのプロパティと区別するための任意のstring値を指定します。

result

\[out, retval] ユーザー定義プロパティの値を受け取るVARIANT変数へのポインターです。

value

\[in] プロパティの新しい値を含むVARIANT変数です。

<div id="return-values">
  ## 戻り値
</div>

このプロパティに固有の戻り値はありません。[ABBYY FineReader Engine 関数の標準戻り値](/ja/fine-reader/engine/api-reference/return-codes)が返されます。

<div id="remarks">
  ## 備考
</div>

プロパティは名前によって識別されます。したがって、1 つのオブジェクトに対して、指定した名前のプロパティは 1 つだけ使用できます。オブジェクトに指定した名前のユーザー プロパティがない場合は、そのプロパティに初めて値が割り当てられた時点で作成されます。オブジェクト内に存在しないプロパティの値を取得しようとすると、空の VARIANT が返されます。[CopyFrom](/ja/fine-reader/engine/visual-components-reference/supplementary-objects/spellwordcollection/copyfrom-method) メソッドを使用してオブジェクトをコピーすると、ユーザー定義プロパティもコピーされます。オブジェクトが永続化される場合、ユーザー定義プロパティも永続化されます。

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

* [BaseLanguage](/ja/fine-reader/engine/api-reference/language-related-objects/baselanguage)
* [Block](/ja/fine-reader/engine/api-reference/layout-related-objects/block)
* [Layout](/ja/fine-reader/engine/api-reference/layout-related-objects/layout)
* [TextLanguage](/ja/fine-reader/engine/api-reference/language-related-objects/textlanguage)

<div id="see-also">
  ## 関連項目
</div>

[プロパティ の操作](/ja/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties)