> ## 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-Eigenschaft

> UserProperty-Eigenschaft in der ABBYY FineReader Engine API — allgemeine Eigenschaft, die benutzerdefinierte VARIANT-Informationen mit einem Objekt verknüpft.

<Note>
  Dies ist eine allgemeine Methode. Alle plattformspezifischen Implementierungseinschränkungen werden in den Themen zu den Objekten aufgeführt, die diese Methode verwenden.
</Note>

Mit dieser Eigenschaft können Sie einem Objekt beliebige benutzerdefinierte Informationen zuordnen. Diese Informationen werden als VARIANT übergeben, das nur einfache Typen (String, Ganzzahltypen) enthalten darf; SAFEARRAY- oder VARIANT-Typen dürfen jedoch nicht innerhalb dieses VARIANT enthalten sein. Genauer gesagt sind nur die folgenden VARIANT-Typen zulässig: 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">
  ## 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">
  ## Parameter
</div>

name

\[in] Diese Variable enthält einen beliebigen Wert vom Typ string, mit dem Sie die Eigenschaft von anderen unterscheiden können, zum Beispiel „MyProperty“.

result

\[out, retval] Ein Zeiger auf eine VARIANT-Variable, die den Wert der benutzerdefinierten Eigenschaft erhält.

value

\[in] Eine VARIANT-Variable, die den neuen Wert für die Eigenschaft enthält.

<div id="return-values">
  ## Rückgabewerte
</div>

Diese Eigenschaft hat keine eigenen Rückgabewerte. Sie gibt die [Standardrückgabewerte von ABBYY FineReader Engine-Funktionen](/de/fine-reader/engine/api-reference/return-codes) zurück.

<div id="remarks">
  ## Bemerkungen
</div>

Eigenschaften werden anhand ihrer Namen identifiziert. Daher ist für ein bestimmtes Objekt nur eine Eigenschaft mit dem angegebenen Namen zulässig. Wenn ein Objekt keine Benutzereigenschaft mit dem angegebenen Namen besitzt, wird sie erstellt, sobald ihr erstmals ein Wert zugewiesen wird. Wird versucht, den Wert einer Eigenschaft abzurufen, die in einem Objekt nicht vorhanden ist, wird ein leeres VARIANT zurückgegeben. Wenn ein Objekt mit der Methode [CopyFrom](/de/fine-reader/engine/visual-components-reference/supplementary-objects/spellwordcollection/copyfrom-method) kopiert wird, werden auch benutzerdefinierte Eigenschaften kopiert. Wenn ein Objekt persistent sein kann, sind auch benutzerdefinierte Eigenschaften persistent.

Die folgenden Objekte stellen diese Eigenschaft bereit:

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

<div id="see-also">
  ## Siehe auch
</div>

[Arbeiten mit Eigenschaften](/de/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties)