> ## 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.

# Propriété UserProperty

> Propriété UserProperty dans l’API ABBYY FineReader Engine — propriété commune qui associe des informations VARIANT définies par l’utilisateur à un objet.

<Note>
  Il s'agit d'une méthode commune. Toute limitation d'implémentation propre à une plateforme sera indiquée dans les rubriques consacrées aux objets qui utilisent cette méthode.
</Note>

Cette propriété vous permet d'associer à un objet toute information définie par l'utilisateur. Cette information est transmise sous forme de VARIANT, qui ne peut contenir que des types simples (String, types entiers), mais ne peut pas contenir de SAFEARRAY ni de VARIANT imbriqué. Plus précisément, seuls les types de variant suivants sont autorisés : 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">
  ## Syntaxe
</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">
  ## Paramètres
</div>

name

\[in] Cette variable contient n'importe quelle valeur de type string que vous souhaitez utiliser pour identifier la propriété parmi les autres, par exemple, "MyProperty".

result

\[out, retval] Un pointeur vers une variable VARIANT qui reçoit la valeur de la propriété définie par l'utilisateur.

value

\[in] Une variable VARIANT qui contient la nouvelle valeur de la propriété.

<div id="return-values">
  ## Valeurs de retour
</div>

Cette propriété n’a pas de valeur de retour spécifique. Elle renvoie les [valeurs de retour standard des fonctions d’ABBYY FineReader Engine](/fr/fine-reader/engine/api-reference/return-codes).

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

Les propriétés sont identifiées par leur nom. Par conséquent, une seule propriété portant un nom donné est autorisée pour un objet donné. Si un objet ne possède pas de propriété utilisateur portant ce nom, elle est créée lors de la première affectation d’une valeur à cette propriété. Si l’on tente d’obtenir la valeur d’une propriété qui n’existe pas dans un objet, un VARIANT vide est renvoyé. Lors de la copie d’un objet via la méthode [CopyFrom](/fr/fine-reader/engine/visual-components-reference/supplementary-objects/spellwordcollection/copyfrom-method), les propriétés définies par l’utilisateur sont également copiées. Si un objet est persistant, les propriétés définies par l’utilisateur le sont également.

Les objets suivants fournissent cette propriété :

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

<div id="see-also">
  ## Voir aussi
</div>

[Utilisation des propriétés](/fr/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties)