Propriété UserProperty

Il s’agit d’une méthode courante. Toute limitation d’implémentation propre à la 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), mais ne peut pas contenir de types SAFEARRAY ni VARIANT imbriqués. 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 de type string 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é n’a pas de valeur de retour spécifique. Elle renvoie les valeurs de retour standard des fonctions d’ABBYY FineReader Engine.

​

Remarques

Les propriétés sont identifiées par leur nom. Ainsi, une seule propriété portant le nom spécifié est autorisée pour un objet donné. Si un objet ne possède pas de propriété définie par l’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 via la méthode CopyFrom, les propriétés définies par l’utilisateur sont également copiées. Si un objet peut être conservé de manière persistante, les propriétés définies par l’utilisateur le sont également.

Les objets suivants fournissent cette propriété :

• BaseLanguage
• Block
• Layout
• TextLanguage

​

Voir aussi

Utilisation des propriétés