Passer au contenu principal
Il s’agit d’une méthode commune. Toute limitation d’implémentation propre à une plateforme est indiquée dans les rubriques des objets qui utilisent cette méthode.
Cette propriété vous permet d’associer à un objet toute information définie par l’utilisateur. Ces informations sont transmises sous forme de VARIANT, qui ne peut contenir que des types simples (String, types entiers) ; il ne peut pas contenir de type SAFEARRAY ni de type 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.

​
Syntaxe

​
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

​
Paramètres

name [in] Cette variable contient n’importe quelle valeur string que vous souhaitez utiliser pour distinguer la propriété des autres, par exemple, “MyProperty”. result [out, retval] Pointeur vers une variable VARIANT qui reçoit la valeur de la propriété définie par l’utilisateur. value [in] Variable VARIANT contenant la nouvelle valeur de la propriété.

​
Valeurs de retour

Cette propriété n’a pas de valeur de retour spécifique. Elle renvoie les valeurs de retour standard des fonctions ABBYY FineReader Engine.

​
Remarques

Les propriétés sont identifiées par leur nom. Ainsi, une seule propriété portant le 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 au moyen de la méthode CopyFrom, les propriétés définies par l’utilisateur sont également copiées. Si un objet peut être conservé, les propriétés définies par l’utilisateur le sont également. Les objets suivants fournissent cette propriété :

​
Voir aussi

Utilisation des propriétés