這是通用方法。任何特定平台的實作限制,都會列於使用此方法之物件的相關主題中。
此屬性可讓您將任何使用者自訂資訊與物件建立關聯。此資訊會以 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。
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] 此變數包含任意 string 值,用於在其他屬性中識別此屬性,例如 “MyProperty”。
result
[out, retval] 指向 VARIANT 變數的指標,該變數會接收使用者定義屬性的值。
value
[in] 包含此屬性新值的 VARIANT 變數。
此屬性沒有特定的回傳值。它會回傳 ABBYY FineReader Engine 函式的標準回傳值。
屬性是以其名稱識別。因此,對於指定的物件,只允許有一個具有該名稱的屬性。如果物件沒有具有指定名稱的使用者屬性,則會在第一次為該屬性指派值時建立。當嘗試取得物件中不存在之屬性的值時,會傳回空的 VARIANT。透過 CopyFrom 方法複製物件時,也會複製使用者定義的屬性。如果物件可持久化,則使用者定義的屬性也會持久化。
下列物件提供此屬性:
使用屬性