> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Propiedad UserProperty

> Propiedad UserProperty en la API de ABBYY FineReader Engine — propiedad común que asocia información VARIANT definida por el usuario con un objeto.

<Note>
  Este es un método común. Cualquier limitación de implementación específica de la plataforma se enumerará en los temas correspondientes a los objetos que usan este método.
</Note>

Esta propiedad le permite asociar cualquier información definida por el usuario a un objeto. 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 concretamente, solo se permiten los siguientes tipos de 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.

<div id="syntax">
  ## Sintaxis
</div>

<div id="c">
  ### C++
</div>

```cpp theme={null}
HRESULT get_UserProperty(
   BSTR     name,
   VARIANT* result
);
HRESULT put_UserProperty(
   BSTR    name,
   VARIANT value
);
```

### C\#

```csharp theme={null}
object get_UserProperty( string name );
void set_UserProperty(
   string name,
   object value
);
```

<div id="visual-basic-net">
  ### Visual Basic .NET
</div>

```vb theme={null}
Property UserProperty(name As String) As Object
```

<div id="parameters">
  ## Parámetros
</div>

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.

<div id="return-values">
  ## Valores de retorno
</div>

Esta propiedad no tiene valores de retorno específicos. Devuelve los [valores de retorno estándar de las funciones de ABBYY FineReader Engine](/es/fine-reader/engine/api-reference/return-codes).

<div id="remarks">
  ## Observaciones
</div>

Las propiedades se identifican por sus nombres. Por lo tanto, solo se permite una propiedad con el nombre especificado para un objeto determinado. Si un objeto no tiene una propiedad de usuario con el nombre especificado, esta se crea la primera vez que se asigna un valor a esa propiedad. 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](/es/fine-reader/engine/visual-components-reference/supplementary-objects/spellwordcollection/copyfrom-method), las propiedades definidas por el usuario también se copian. Si un objeto es persistente, las propiedades definidas por el usuario también lo son.

Los siguientes objetos proporcionan esta propiedad:

* [BaseLanguage](/es/fine-reader/engine/api-reference/language-related-objects/baselanguage)
* [Block](/es/fine-reader/engine/api-reference/layout-related-objects/block)
* [Layout](/es/fine-reader/engine/api-reference/layout-related-objects/layout)
* [TextLanguage](/es/fine-reader/engine/api-reference/language-related-objects/textlanguage)

<div id="see-also">
  ## Consulte también
</div>

[Uso de Propiedades](/es/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties)