Método ITfKeystrokeMgr::P reserveKey (msctf.h)

Artículo
03/08/2023

Registra una clave conservada.

Sintaxis

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

Parámetros

[in] tid

Contiene el identificador de cliente del servicio de texto TSF. Este valor se pasa al servicio de texto TSF en su método ITfTextInputProcessor::Activate .

[in] rguid

Contiene el GUID de comando de la clave conservada. Este valor se pasa al método ITfKeyEventSink::OnPreservedKey del servicio de texto de TSF para identificar la clave conservada cuando se activa la clave conservada.

[in] prekey

Puntero a una estructura de TF_PRESERVEDKEY que especifica la clave conservada. El miembro uVKey contiene el código de clave virtual y el miembro uModifiers identifica los modificadores de la clave conservada.

[in] pchDesc

Puntero a una cadena Unicode que contiene la descripción de la clave conservada. Esto no puede ser NULL a menos que cchDesc sea cero.

[in] cchDesc

Especifica el número de caracteres en pchDesc. Pase cero para este parámetro si no se requiere ninguna descripción.

Valor devuelto

Este método puede devolver uno de estos valores.

Valor	Descripción
S_OK	Método realizado correctamente.
TF_E_ALREADY_EXISTS	La clave conservada está registrada.
E_INVALIDARG	Uno o varios parámetros no son válidos.
E_OUTOFMEMORY	Error de asignación de memoria.
E_FAIL	Se ha producido un error no especificado.

Comentarios

Los servicios de texto de TSF registran las teclas conservadas y proporcionan métodos abreviados de teclado a comandos comunes implementados por el servicio de texto TSF.

Requisitos


Cliente mínimo compatible	Windows 2000 Professional [aplicaciones de escritorio \| Aplicaciones para UWP]
Servidor mínimo compatible	Windows 2000 Server [aplicaciones de escritorio \| Aplicaciones para UWP]
Plataforma de destino	Windows
Encabezado	msctf.h
Archivo DLL	Msctf.dll
Redistribuible	TSF 1.0 en Windows 2000 Professional