ITfKeystrokeMgr::P reserveKey, méthode (msctf.h)

Article
08/24/2023

Inscrit une clé conservée.

Syntaxe

HRESULT PreserveKey(
  [in] TfClientId            tid,
  [in] REFGUID               rguid,
  [in] const TF_PRESERVEDKEY *prekey,
  [in] const WCHAR           *pchDesc,
  [in] ULONG                 cchDesc
);

Paramètres

[in] tid

Contient l’identificateur client du service de texte TSF. Cette valeur est passée au service de texte TSF dans sa méthode ITfTextInputProcessor::Activate .

[in] rguid

Contient le GUID de commande de la clé conservée. Cette valeur est passée à la méthode ITfKeyEventSink::OnPreservedKeyKey du service de texte TSF pour identifier la clé conservée lorsque la clé conservée est activée.

[in] prekey

Pointeur vers une structure TF_PRESERVEDKEY qui spécifie la clé conservée. Le membre uVKey contient le code de clé virtuelle et le membre uModifiers identifie les modificateurs de la clé conservée.

[in] pchDesc

Pointeur vers une chaîne Unicode qui contient la description de la clé conservée. Cela ne peut pas être NULL , sauf si cchDesc est égal à zéro.

[in] cchDesc

Spécifie le nombre de caractères dans pchDesc. Passez zéro pour ce paramètre si aucune description n’est requise.

Valeur retournée

Cette méthode peut retourner l’une de ces valeurs.

Valeur	Description
S_OK	La méthode a réussi.
TF_E_ALREADY_EXISTS	La clé conservée est inscrite.
E_INVALIDARG	Un ou plusieurs paramètres ne sont pas valides.
E_OUTOFMEMORY	Une erreur d’allocation de mémoire s’est produite.
E_FAIL	Une erreur non spécifiée s'est produite.

Notes

Les touches conservées sont inscrites par les services de texte TSF et fournissent des raccourcis clavier aux commandes courantes implémentées par le service de texte TSF.

Spécifications


Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau \| Applications UWP]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau \| Applications UWP]
Plateforme cible	Windows
En-tête	msctf.h
DLL	Msctf.dll
Composant redistribuable	TSF 1.0 sur Windows 2000 Professionnel