Dies ist eine allgemeine Methode. Alle plattformspezifischen 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 kann; SAFEARRAY- oder VARIANT-Typen darf dieses VARIANT jedoch nicht enthalten. 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.
HRESULT get_UserProperty(
BSTR name,
VARIANT* result
);
HRESULT put_UserProperty(
BSTR name,
VARIANT value
);
object get_UserProperty( string name );
void set_UserProperty(
string name,
object value
);
Property UserProperty(name As String) As Object
name
[in] Diese Variable enthält einen beliebigen string-Wert, 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 aufnimmt.
value
[in] Eine VARIANT-Variable, die den neuen Wert der Eigenschaft enthält.
Diese Eigenschaft hat keine spezifischen Rückgabewerte. Sie gibt die Standardrückgabewerte von ABBYY FineReader Engine-Funktionen zurück.
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. Wird versucht, den Wert einer Eigenschaft abzurufen, die im Objekt nicht vorhanden ist, wird ein leeres VARIANT zurückgegeben. Beim Kopieren eines Objekts mit der Methode CopyFrom werden auch benutzerdefinierte Eigenschaften kopiert. Wenn ein Objekt persistent sein kann, sind auch benutzerdefinierte Eigenschaften persistent.
Die folgenden Objekte stellen diese Eigenschaft bereit:
Arbeiten mit Eigenschaften