ITfKeystrokeMgr::P reserveKey 方法 (msctf.h)

註冊保留的金鑰。

語法

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

參數

[in] tid

包含 TSF 文字服務的用戶端識別碼。 此值會在其 ITfTextInputProcessor::Activate 方法中傳遞至 TSF 文字服務。

[in] rguid

包含保留金鑰的命令 GUID。 此值會傳遞至 TSF 文字服務 ITfKeyEventSink::OnPreservedKey 方法,以在啟用保留金鑰時識別保留的金鑰。

[in] prekey

指定保留索引鍵 之TF_PRESERVEDKEY 結構的指標。 uVKey成員包含虛擬金鑰程式碼,而 uModifiers成員會識別保留金鑰的修飾詞。

[in] pchDesc

Unicode 字串的指標,其中包含保留索引鍵的描述。 除非cchDesc為零,否則這不可以是Null

[in] cchDesc

指定 pchDesc中的字元數。 如果不需要描述,則為此參數傳遞零。

傳回值

這個方法可以傳回下列其中一個值。

描述
S_OK
此方法成功。
TF_E_ALREADY_EXISTS
已登錄保留的金鑰。
E_INVALIDARG
一或多個參數無效。
E_OUTOFMEMORY
發生記憶體配置錯誤。
E_FAIL
發生未指定的錯誤。

備註

保留的按鍵是由 TSF 文字服務註冊,並提供 TSF 文字服務所實作之常見命令的鍵盤快速鍵。

需求

   
最低支援的用戶端 Windows 2000 專業版 [傳統型應用程式 |UWP 應用程式]
最低支援的伺服器 Windows 2000 Server [傳統型應用程式 |UWP 應用程式]
目標平台 Windows
標頭 msctf.h
Dll Msctf.dll
可轉散發套件 Windows 2000 專業版上的 TSF 1.0

另請參閱

ITfKeyEventSink::OnPreservedKey

ITfKeystrokeMgr

ITfKeystrokeMgr::UnpreserveKey

ITfTextInputProcessor::Activate

TF_PRESERVEDKEY