Este es un método común. Cualquier limitación de implementación específica de la plataforma se indicará en los temas correspondientes a los objetos que usan este método.
Esta propiedad le permite asociar a un objeto cualquier información definida por el usuario. Esta información se pasa como VARIANT, que solo puede contener tipos simples (String, tipos enteros), pero no puede contener tipos SAFEARRAY ni tipos VARIANT dentro de este VARIANT. Más precisamente, solo se permiten los siguientes tipos de variante: 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] Esta variable contiene cualquier valor de cadena que desee usar para identificar la propiedad entre las demás, por ejemplo, “MyProperty”.
result
[out, retval] Un puntero a una variable VARIANT que recibe el valor de la propiedad definida por el usuario.
value
[in] Una variable VARIANT que contiene el nuevo valor de la propiedad.
Esta propiedad no tiene valores de retorno específicos. Devuelve los valores de retorno estándar de las funciones de ABBYY FineReader Engine.
Las propiedades se identifican por sus nombres. Por lo tanto, para un objeto determinado solo se permite una propiedad con el nombre especificado. Si un objeto no tiene una propiedad de usuario con el nombre especificado, esta se crea cuando se le asigna un valor por primera vez. Si se intenta obtener el valor de una propiedad que no existe en un objeto, se devuelve un VARIANT vacío. Al copiar un objeto mediante el método CopyFrom, también se copian las propiedades definidas por el usuario. Si un objeto puede conservarse, las propiedades definidas por el usuario también se conservan.
Los siguientes objetos proporcionan esta propiedad:
Trabajar con propiedades