Zum Hauptinhalt springen
Dies ist eine allgemeine Methode. Plattformspezifische Implementierungseinschränkungen sind in den Themen zu den Objekten aufgeführt, die diese Methode verwenden.
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 innerhalb dieses VARIANT sind jedoch nicht zulässig. 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.

​
Syntax

​
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

​
Parameter

name [in] Diese Variable enthält einen beliebigen string-Wert, mit dem Sie die Eigenschaft beispielsweise als „MyProperty“ eindeutig identifizieren können. result [out, retval] Ein Zeiger auf eine VARIANT-Variable, die den Wert der benutzerdefinierten Eigenschaft aufnimmt. value [in] Eine VARIANT-Variable, die den neuen Wert der Eigenschaft enthält.

​
Rückgabewerte

Diese Eigenschaft hat keine spezifischen Rückgabewerte. Sie liefert die Standardrückgabewerte der ABBYY FineReader Engine-Funktionen zurück.

​
Hinweise

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 hat, wird sie erstellt, sobald ihr erstmals ein Wert zugewiesen wird. Wenn versucht wird, 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 kopiert wird, werden auch benutzerdefinierte Eigenschaften kopiert. Wenn ein Objekt persistent sein kann, sind auch benutzerdefinierte Eigenschaften persistent. Die folgenden Objekte verfügen über diese Eigenschaft:

​
Siehe auch

Arbeiten mit Eigenschaften