Freigeben über


ITfKeystrokeMgr::P reserveKey-Methode (msctf.h)

Registriert einen beibehaltenen Schlüssel.

Syntax

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

Parameter

[in] tid

Enthält den Clientbezeichner des TSF-Textdiensts. Dieser Wert wird an den TSF-Textdienst in seiner ITfTextInputProcessor::Activate-Methode übergeben.

[in] rguid

Enthält die Befehls-GUID des beibehaltenen Schlüssels. Dieser Wert wird an die TSF-Textdienstmethode ITfKeyEventSink::OnPreservedKey übergeben, um den beibehaltenen Schlüssel zu identifizieren, wenn der beibehaltene Schlüssel aktiviert wird.

[in] prekey

Zeiger auf eine TF_PRESERVEDKEY-Struktur , die den beibehaltenen Schlüssel angibt. Das uVKey-Element enthält den virtuellen Schlüsselcode, und das uModifiers-Element identifiziert die Modifizierer des beibehaltenen Schlüssels.

[in] pchDesc

Zeiger auf eine Unicode-Zeichenfolge, die die Beschreibung des beibehaltenen Schlüssels enthält. Dies kann nicht NULL sein, es sei denn , cchDesc ist null.

[in] cchDesc

Gibt die Anzahl der Zeichen in pchDesc an. Übergeben Sie null für diesen Parameter, wenn keine Beschreibung erforderlich ist.

Rückgabewert

Diese Methode kann einen dieser Werte zurückgeben.

Wert BESCHREIBUNG
S_OK
Die Methode war erfolgreich.
TF_E_ALREADY_EXISTS
Der beibehaltene Schlüssel wird registriert.
E_INVALIDARG
Mindestens ein Parameter ist ungültig.
E_OUTOFMEMORY
Ein Speicherbelegungsfehler ist aufgetreten.
E_FAIL
Es ist ein unbekannter Fehler aufgetreten.

Hinweise

Beibehaltene Tasten werden von TSF-Textdiensten registriert und stellen Tastenkombinationen für allgemeine Befehle bereit, die vom TSF-Textdienst implementiert werden.

Anforderungen

   
Unterstützte Mindestversion (Client) Windows 2000 Professional [Desktop-Apps | UWP-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [Desktop-Apps | UWP-Apps]
Zielplattform Windows
Kopfzeile msctf.h
DLL Msctf.dll
Verteilbare Komponente TSF 1.0 unter Windows 2000 Professional

Weitere Informationen

ITfKeyEventSink::OnPreservedKey

ITfKeystrokeMgr

ITfKeystrokeMgr::UnpreserveKey

ITfTextInputProcessor::Activate

TF_PRESERVEDKEY