GetContextPropertyValue, fonction (recapis.h)

Article
03/01/2024

Retourne une valeur de propriété spécifiée à partir du contexte du module de reconnaissance.

Syntaxe

HRESULT GetContextPropertyValue(
  HRECOCONTEXT hrc,
  GUID         *pGuid,
  ULONG        *pcbSize,
  BYTE         *pProperty
);

Paramètres

hrc

Handle du contexte du module de reconnaissance.

pGuid

Propriétés à récupérer. Spécifiez un identificateur global unique (GUID) de propriété prédéfinie ou un GUID défini par l’application. Pour obtenir la liste des propriétés prédéfinies, consultez les GUID de propriété de reconnaissance.

pcbSize

En entrée, la taille, en octets, la mémoire tampon pProperty peut être. Sur la sortie, la taille, en octets, la mémoire tampon pProperty est.

pProperty

Mémoire tampon allouée par l’utilisateur pour contenir la valeur de propriété. Pour déterminer la taille de la mémoire tampon, définissez pProperty sur NULL ; utiliser la taille pour allouer pProperty.

Valeur retournée

Cette fonction peut retourner l’une de ces valeurs.

Code de retour	Description
S_OK	Réussite.
E_POINTER	L’un des paramètres est un pointeur non valide.
E_FAIL	Une erreur non spécifiée s'est produite.
E_INVALIDARG	Un argument non valide a été reçu.
TPC_E_UNINITIALIZED_PROPERTY	La propriété n’a pas été définie par le contexte. Cela peut se produire si la propriété n’est définie que dans certaines circonstances, ou si la propriété ne doit être définie qu’après un événement qui ne s’est pas encore produit.
TPC_E_INVALID_PROPERTY	Le module de reconnaissance ne prend pas en charge la propriété .
TPC_E_INSUFFICIENT_BUFFER	La mémoire tampon pProperty est trop petite.

Remarques

Cette fonction est facultative.

Vous pouvez utiliser la fonction GetContextPropertyValue pour obtenir des informations que le module de reconnaissance retourne à l’appelant. Cela permet à un module de reconnaissance personnalisé d’avoir des modes et des paramètres, et de retourner des données propres à ce module de reconnaissance.

Dans les modules de reconnaissance Microsoft, l’appel de la fonction GetContextPropertyValue avec le paramètre pcbSize défini sur une valeur supérieure à celle requise n’entraîne pas une valeur de retour incorrecte. Au lieu de cela, le code remplace automatiquement la taille par la valeur requise pour le GUID actuel.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP Édition Tablette PC [applications de bureau uniquement]
Serveur minimal pris en charge	Aucun pris en charge
Plateforme cible	Windows
En-tête	recapis.h
DLL	inkobjcore.dll

Voir aussi

GetContextPropertyList, fonction

SetContextPropertyValue, fonction

Partager via