跳转到主要内容
这是一种通用方法。任何平台特定的实现限制,都会在使用此方法的对象主题中列出。
此属性允许您将任何用户定义的信息与对象关联。该信息以 VARIANT 形式传递,其中只能包含简单类型 (String、整数类型) ,但此 VARIANT 内部不能包含 SAFEARRAY 或 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。

语法

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

参数

name [in] 此变量包含任意 string 值,用于在其他属性中标识该属性,例如“MyProperty”。 result [out, retval] 指向 VARIANT 变量的指针,该变量接收用户定义属性的值。 value [in] 包含该属性新值的 VARIANT 变量。

返回值

此属性没有特定的返回值。它返回 ABBYY FineReader Engine 函数的标准返回值

备注

属性通过名称来标识。因此,对同一对象,只允许存在一个具有指定名称的属性。如果对象中不存在具有指定名称的用户属性,则会在首次为该属性赋值时创建该属性。尝试获取对象中不存在的属性值时,将返回空 VARIANT。通过 CopyFrom 方法复制对象时,用户定义的属性也会被复制。如果对象可以持久保存,则用户定义的属性也会被持久保存。 以下对象提供此属性:

另请参阅

属性的使用