ホーム › UI.TextServices › ITfFnPropertyUIStatus

ITfFnPropertyUIStatus

COM

📘 Microsoft Learn (日本語) · English

IID2338ac6e-2b9d-44c0-a75e-ee64f256b3bd継承元ITfFunction自前メソッド開始 vtbl4

公式ドキュメント

ITfFnPropertyUIStatus インターフェイスはテキストサービスによって実装され、アプリケーションまたはテキストサービスがテキストサービスのプロパティ UI の状態を取得および設定するために使用します。

メソッド 2

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 4 HRESULT GetStatus(GUID* refguidProp, DWORD* pdw)

ITfFnPropertyUIStatus::GetStatus メソッド

refguidProp

GUID*

プロパティ識別子を指定します。カスタムの識別子、または定義済みプロパティの識別子のいずれかを指定できます。

pdw

DWORD*

out

プロパティ UI の状態を受け取る DWORD へのポインターです。0、または次の値を指定できます。

値	意味
TF_PROPUI_STATUS_SAVETOFILE	プロパティをシリアル化できます。この値が指定されていない場合、プロパティはシリアル化できません。

戻り値

このメソッドは次のいずれかの値を返します。

値	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	pdw が無効です。
E_NOTIMPL	テキストサービスがこのメソッドをサポートしていません。

vtbl 5 HRESULT SetStatus(GUID* refguidProp, DWORD dw)

ITfFnPropertyUIStatus::SetStatus メソッド

refguidProp	GUID*	in	プロパティ識別子を指定します。カスタムの識別子、または定義済みプロパティの識別子のいずれかを指定できます。
dw	DWORD	in	新しいプロパティ UI の状態を格納します。指定できる値については、ITfFnPropertyUIStatus::GetStatus の pdw パラメーターを参照してください。

戻り値

このメソッドは次のいずれかの値を返します。

値	説明
S_OK	メソッドは成功しました。
E_NOTIMPL	テキストサービスがこのメソッドをサポートしていません。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_ITfFnPropertyUIStatus "{2338AC6E-2B9D-44C0-A75E-EE64F256B3BD}"
#usecom global ITfFnPropertyUIStatus IID_ITfFnPropertyUIStatus "{}"
#comfunc global ITfFnPropertyUIStatus_GetStatus  4 var,var
#comfunc global ITfFnPropertyUIStatus_SetStatus  5 var,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_ITfFnPropertyUIStatus "{2338AC6E-2B9D-44C0-A75E-EE64F256B3BD}"
#usecom global ITfFnPropertyUIStatus IID_ITfFnPropertyUIStatus "{}"
#comfunc global ITfFnPropertyUIStatus_GetStatus  4 sptr,sptr
#comfunc global ITfFnPropertyUIStatus_SetStatus  5 sptr,int
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。