Passer au contenu principal
Il s’agit d’une méthode commune. Toute limitation d’implémentation propre à une plateforme sera répertoriée dans les rubriques des objets utilisant cette méthode.
Cette propriété vous permet d’associer à un objet n’importe quelle 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), mais ne peut contenir aucun type SAFEARRAY ou 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 une valeur de type string quelconque que vous souhaitez utiliser pour identifier la propriété parmi d’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é.

​
Valeurs de retour

Cette propriété ne comporte pas de valeurs de retour spécifiques. 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 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 lorsqu’une valeur lui est affectée pour la première fois. 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 à l’aide de la méthode CopyFrom, les propriétés définies par l’utilisateur sont également copiées. Si un objet peut être persistant, les propriétés définies par l’utilisateur le sont également. Les objets suivants disposent de cette propriété :

​
Voir aussi

Utilisation des propriétés