ホーム › UI.TextServices › ITfInputProcessorProfiles

ITfInputProcessorProfiles

COM

📘 Microsoft Learn (日本語) · English

IID1f02b6c5-7842-4ee6-8a0b-9a24183a95ca継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ITfInputProcessorProfiles インターフェイスは TSF マネージャーによって実装され、アプリケーションまたはテキストサービスが 1 つ以上のテキストサービスの言語プロファイルを操作するために使用します。

解説(Remarks)

このインターフェイスへのポインターを取得するには、CLSID_TF_InputProcessorProfiles を指定して CoCreateInstance を呼び出します。

例

ITfInputProcessorProfiles


HRESULT hr;
ITfInputProcessorProfiles *pProfiles;

//オブジェクトを作成します。 
hr = CoCreateInstance(  CLSID_TF_InputProcessorProfiles, 
                        NULL, 
                        CLSCTX_INPROC_SERVER, 
                        IID_ITfInputProcessorProfiles, 
                        (LPVOID*)&pProfiles);

if(SUCCEEDED(hr))
{
    //インターフェイスを使用します。 

    //インターフェイスを解放します。 
    pProfiles->Release();
}

メソッド 18

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

vtbl 3 HRESULT Register(GUID* rclsid)

ITfInputProcessorProfiles::Register メソッド

rclsid

GUID*

登録するテキストサービスの CLSID を格納します。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生しました。

vtbl 4 HRESULT Unregister(GUID* rclsid)

ITfInputProcessorProfiles::Unregister メソッド

rclsid

GUID*

登録を解除するテキストサービスの CLSID を格納します。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生しました。

vtbl 5 HRESULT AddLanguageProfile(GUID* rclsid, WORD langid, GUID* guidProfile, LPWSTR pchDesc, DWORD cchDesc, LPWSTR pchIconFile, DWORD cchFile, DWORD uIconIndex)

ITfInputProcessorProfiles::AddLanguageProfile メソッド

rclsid	GUID*	in	テキストサービスの CLSID を格納します。
langid	WORD	in	テキストサービスの追加先となるプロファイルの言語識別子を指定する LANGID 値を格納します。-1 を指定した場合、テキストサービスはすべての言語に追加されます。
guidProfile	GUID*	in	言語プロファイルを識別する GUID 値を格納します。これは、そのプロファイルがアクティブなときに ITfInputProcessorProfiles::GetActiveLanguageProfile によって取得される値です。
pchDesc	LPWSTR	in	プロファイル内のテキストサービスの説明文字列を格納する WCHAR バッファーへのポインターです。これは言語バーに表示されるテキストサービス名です。
cchDesc	DWORD	in	pchDesc 内の説明文字列の長さ (文字数) を格納します。-1 を指定した場合、pchDesc は NULL 終端文字列とみなされます。
pchIconFile	LPWSTR	in	プロファイル内のテキストサービスについて言語バーに表示するアイコンを含むファイルの、パスとファイル名を格納する WCHAR バッファーへのポインターです。このファイルは実行可能ファイル (.exe)、DLL (.dll)、またはアイコンファイル (.ico) のいずれかです。このパラメーターは省略可能で、NULL を指定できます。その場合、テキストサービスには既定のアイコンが表示されます。
cchFile	DWORD	in	pchIconFile 内のアイコンファイル文字列の長さ (文字数) を格納します。-1 を指定した場合、pchIconFile は NULL 終端文字列とみなされます。pchIconFile が NULL の場合、このパラメーターは無視されます。
uIconIndex	DWORD	in	プロファイル内のテキストサービスについて言語バーに表示する、pchIconFile 内のアイコンの 0 から始まるインデックスを格納します。pchIconFile が NULL の場合、このパラメーターは無視されます。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	pszDesc が無効です。

vtbl 6 HRESULT RemoveLanguageProfile(GUID* rclsid, WORD langid, GUID* guidProfile)

ITfInputProcessorProfiles::RemoveLanguageProfile メソッド

rclsid	GUID*	in	テキストサービスの CLSID を格納します。
langid	WORD	in	プロファイルの言語識別子を指定する LANGID 値を格納します。
guidProfile	GUID*	in	言語プロファイルを識別する GUID 値を格納します。これは、プロファイルを追加したときに ITfInputProcessorProfiles::AddLanguageProfile で指定した値です。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生しました。

vtbl 7 HRESULT EnumInputProcessorInfo(IEnumGUID** ppEnum)

ITfInputProcessorProfiles::EnumInputProcessorInfo メソッド

ppEnum

IEnumGUID**

out

列挙子オブジェクトを受け取る IEnumGUID インターフェイスポインターへのポインターです。列挙子には、登録されている各テキストサービスの CLSID が含まれます。呼び出し元は、不要になった時点でこのオブジェクトを解放する必要があります。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	ppEnum が無効です。
E_OUTOFMEMORY	メモリ割り当てエラーが発生しました。

vtbl 8 HRESULT GetDefaultLanguageProfile(WORD langid, GUID* catid, GUID* pclsid, GUID* pguidProfile)

ITfInputProcessorProfiles::GetDefaultLanguageProfile メソッド

langid	WORD	in	既定のプロファイルを取得する対象の言語を指定する LANGID 値を格納します。
catid	GUID*	in	テキストサービスが登録されているカテゴリを識別する GUID 値を格納します。これはユーザー定義のカテゴリ、または定義済みのカテゴリ値のいずれかです。
pclsid	GUID*	out	その言語の既定のテキストサービスのクラス識別子を受け取る CLSID 値へのポインターです。
pguidProfile	GUID*	out	その言語の既定のプロファイルの識別子を受け取る GUID 値へのポインターです。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
S_FALSE	指定された言語およびカテゴリに対する既定の言語プロファイルが見つかりませんでした。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	1 つ以上のパラメーターが無効です。

vtbl 9 HRESULT SetDefaultLanguageProfile(WORD langid, GUID* rclsid, GUID* guidProfiles)

ITfInputProcessorProfiles::SetDefaultLanguageProfile メソッド

langid	WORD	in	既定のプロファイルを設定する対象の言語を指定する LANGID 値を格納します。
rclsid	GUID*	in	その言語の既定となるテキストサービスの CLSID を格納します。
guidProfiles	GUID*	in	既定となる言語プロファイルを識別する GUID 値を格納します。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	1 つ以上のパラメーターが無効です。

vtbl 10 HRESULT ActivateLanguageProfile(GUID* rclsid, WORD langid, GUID* guidProfiles)

ITfInputProcessorProfiles::ActivateLanguageProfile メソッド

rclsid	GUID*	in	アクティブにするテキストサービスの CLSID を格納します。
langid	WORD	in	既定のプロファイルを設定する対象の言語を指定する LANGID 値を格納します。現在アクティブな言語でない場合、このメソッドは失敗します。
guidProfiles	GUID*	in	アクティブにする言語プロファイルを識別する GUID 値を格納します。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	1 つ以上のパラメーターが無効です。
E_OUTOFMEMORY	メモリ割り当てに失敗しました。
E_UNEXPECTED	呼び出し元スレッドに対してスレッドマネージャーが作成されていません。

vtbl 11 HRESULT GetActiveLanguageProfile(GUID* rclsid, WORD* plangid, GUID* pguidProfile)

ITfInputProcessorProfiles::GetActiveLanguageProfile メソッド

rclsid	GUID*	in	テキストサービスの CLSID を格納します。
plangid	WORD*	out	アクティブなプロファイルの言語識別子を受け取る LANGID 値へのポインターです。
pguidProfile	GUID*	out	言語プロファイルの識別子を受け取る GUID 値へのポインターです。これは、プロファイルを追加したときに ITfInputProcessorProfiles::AddLanguageProfile で指定した値です。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
S_FALSE	rclsid で指定されたテキストサービスは現在アクティブではありません。pguidProfile は GUID_NULL を受け取ります。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	1 つ以上のパラメーターが無効です。
E_OUTOFMEMORY	メモリ割り当てエラーが発生しました。

vtbl 12 HRESULT GetLanguageProfileDescription(GUID* rclsid, WORD langid, GUID* guidProfile, LPWSTR* pbstrProfile)

ITfInputProcessorProfiles::GetLanguageProfileDescription メソッド

rclsid	GUID*	in	プロファイルの説明を取得する対象のテキストサービスの CLSID を格納します。
langid	WORD	in	プロファイルの説明を取得する対象の言語を指定する LANGID 値を格納します。
guidProfile	GUID*	in	プロファイルの説明を取得する対象の言語を識別する GUID 値を格納します。
pbstrProfile	LPWSTR*	out	説明文字列を受け取る BSTR 値へのポインターです。呼び出し元は、不要になった時点で SysFreeString を使用してこのメモリを解放する責任があります。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	pbstrProfile が無効です。

vtbl 13 HRESULT GetCurrentLanguage(WORD* plangid)

ITfInputProcessorProfiles::GetCurrentLanguage メソッド

plangid

WORD*

out

現在アクティブな言語の言語識別子を受け取る LANGID 値へのポインターです。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	plangid が無効です。

vtbl 14 HRESULT ChangeCurrentLanguage(WORD langid)

ITfInputProcessorProfiles::ChangeCurrentLanguage メソッド

langid

WORD

アクティブにする言語の LANGID を格納します。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	langid が無効な言語識別子です。
E_OUTOFMEMORY	メモリ割り当てに失敗しました。
E_UNEXPECTED	呼び出し元スレッドに対してスレッドマネージャーが作成されていません。

vtbl 15 HRESULT GetLanguageList(WORD** ppLangId, DWORD* pulCount)

ITfInputProcessorProfiles::GetLanguageList メソッド

ppLangId	WORD**	out	現在インストールされている言語の識別子の配列を受け取る LANGID ポインターへのポインターです。この配列に格納された識別子の数は pulCount に返されます。配列はこのメソッドによって割り当てられます。呼び出し元は、不要になった時点で CoTaskMemFree を使用してこのメモリを解放する必要があります。
pulCount	DWORD*	out	ppLangId の配列に格納された識別子の数を受け取る ULONG 値へのポインターです。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生しました。
E_INVALIDARG	1 つ以上のパラメーターが無効です。
E_OUTOFMEMORY	メモリ割り当てに失敗しました。

vtbl 16 HRESULT EnumLanguageProfiles(WORD langid, IEnumTfLanguageProfiles** ppEnum)

ITfInputProcessorProfiles::EnumLanguageProfiles メソッド

langid	WORD	in	列挙子を取得する対象の言語を指定する LANGID 値を格納します。
ppEnum	IEnumTfLanguageProfiles**	out	列挙子オブジェクトを受け取る IEnumTfLanguageProfiles インターフェイスポインターへのポインターです。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_FAIL	対応する言語プロファイルがオペレーティングシステム内に見つかりませんでした。または不特定のエラーが発生しました。
E_INVALIDARG	ppEnum が無効です。
E_OUTOFMEMORY	メモリ割り当てに失敗しました。

vtbl 17 HRESULT EnableLanguageProfile(GUID* rclsid, WORD langid, GUID* guidProfile, BOOL fEnable)

ITfInputProcessorProfiles::EnableLanguageProfile メソッド

rclsid	GUID*	in	有効または無効にするプロファイルのテキストサービスの CLSID を格納します。
langid	WORD	in	有効または無効にするプロファイルの言語を指定する LANGID 値を格納します。
guidProfile	GUID*	in	有効または無効にするプロファイルを識別する GUID 値を格納します。
fEnable	BOOL	in	プロファイルを有効にするか無効にするかを指定する BOOL 値を格納します。0 以外の値を指定すると、プロファイルは有効になります。0 を指定すると、プロファイルは無効になります。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生しました。

vtbl 18 HRESULT IsEnabledLanguageProfile(GUID* rclsid, WORD langid, GUID* guidProfile, BOOL* pfEnable)

ITfInputProcessorProfiles::IsEnabledLanguageProfile メソッド

rclsid	GUID*	in	対象のプロファイルのテキストサービスの CLSID を格納します。
langid	WORD	in	対象のプロファイルの言語を指定する LANGID 値を格納します。
guidProfile	GUID*	in	対象のプロファイルを識別する GUID 値を格納します。
pfEnable	BOOL*	out	プロファイルが有効か無効かを示す値を受け取る BOOL 値へのポインターです。0 以外の値を受け取った場合、プロファイルは有効です。0 を受け取った場合、プロファイルは無効です。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_INVALIDARG	pfEnable が無効です。

vtbl 19 HRESULT EnableLanguageProfileByDefault(GUID* rclsid, WORD langid, GUID* guidProfile, BOOL fEnable)

ITfInputProcessorProfiles::EnableLanguageProfileByDefault メソッド

rclsid	GUID*	in	有効または無効にするプロファイルのテキストサービスの CLSID を格納します。
langid	WORD	in	有効または無効にするプロファイルの言語を指定する LANGID 値を格納します。
guidProfile	GUID*	in	有効または無効にするプロファイルを識別する GUID 値を格納します。
fEnable	BOOL	in	プロファイルを有効にするか無効にするかを指定する BOOL 値を格納します。0 以外の値を指定すると、プロファイルは有効になります。0 を指定すると、プロファイルは無効になります。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生しました。

vtbl 20 HRESULT SubstituteKeyboardLayout(GUID* rclsid, WORD langid, GUID* guidProfile, HKL hKL)

ITfInputProcessorProfiles::SubstituteKeyboardLayout メソッド

rclsid	GUID*	in	対象のプロファイルのテキストサービスの CLSID を格納します。
langid	WORD	in	対象のプロファイルの言語を指定する LANGID 値を格納します。
guidProfile	GUID*	in	対象のプロファイルを識別する GUID 値を格納します。
hKL	HKL	in	代替キーボードの入力ロケール識別子を指定する HKL 値を格納します。この値は LoadKeyboardLayout を呼び出して取得します。

戻り値

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

値	説明
S_OK	メソッドは成功しました。
E_FAIL	不特定のエラーが発生しました。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_ITfInputProcessorProfiles "{1F02B6C5-7842-4EE6-8A0B-9A24183A95CA}"
#usecom global ITfInputProcessorProfiles IID_ITfInputProcessorProfiles "{}"
#comfunc global ITfInputProcessorProfiles_Register                        3 var
#comfunc global ITfInputProcessorProfiles_Unregister                      4 var
#comfunc global ITfInputProcessorProfiles_AddLanguageProfile              5 var,int,var,wstr,int,wstr,int,int
#comfunc global ITfInputProcessorProfiles_RemoveLanguageProfile           6 var,int,var
#comfunc global ITfInputProcessorProfiles_EnumInputProcessorInfo          7 sptr
#comfunc global ITfInputProcessorProfiles_GetDefaultLanguageProfile       8 int,var,var,var
#comfunc global ITfInputProcessorProfiles_SetDefaultLanguageProfile       9 int,var,var
#comfunc global ITfInputProcessorProfiles_ActivateLanguageProfile         10 var,int,var
#comfunc global ITfInputProcessorProfiles_GetActiveLanguageProfile        11 var,var,var
#comfunc global ITfInputProcessorProfiles_GetLanguageProfileDescription   12 var,int,var,var
#comfunc global ITfInputProcessorProfiles_GetCurrentLanguage              13 var
#comfunc global ITfInputProcessorProfiles_ChangeCurrentLanguage           14 int
#comfunc global ITfInputProcessorProfiles_GetLanguageList                 15 var,var
#comfunc global ITfInputProcessorProfiles_EnumLanguageProfiles            16 int,sptr
#comfunc global ITfInputProcessorProfiles_EnableLanguageProfile           17 var,int,var,int
#comfunc global ITfInputProcessorProfiles_IsEnabledLanguageProfile        18 var,int,var,var
#comfunc global ITfInputProcessorProfiles_EnableLanguageProfileByDefault  19 var,int,var,int
#comfunc global ITfInputProcessorProfiles_SubstituteKeyboardLayout        20 var,int,var,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_ITfInputProcessorProfiles "{1F02B6C5-7842-4EE6-8A0B-9A24183A95CA}"
#usecom global ITfInputProcessorProfiles IID_ITfInputProcessorProfiles "{}"
#comfunc global ITfInputProcessorProfiles_Register                        3 sptr
#comfunc global ITfInputProcessorProfiles_Unregister                      4 sptr
#comfunc global ITfInputProcessorProfiles_AddLanguageProfile              5 sptr,int,sptr,wstr,int,wstr,int,int
#comfunc global ITfInputProcessorProfiles_RemoveLanguageProfile           6 sptr,int,sptr
#comfunc global ITfInputProcessorProfiles_EnumInputProcessorInfo          7 sptr
#comfunc global ITfInputProcessorProfiles_GetDefaultLanguageProfile       8 int,sptr,sptr,sptr
#comfunc global ITfInputProcessorProfiles_SetDefaultLanguageProfile       9 int,sptr,sptr
#comfunc global ITfInputProcessorProfiles_ActivateLanguageProfile         10 sptr,int,sptr
#comfunc global ITfInputProcessorProfiles_GetActiveLanguageProfile        11 sptr,sptr,sptr
#comfunc global ITfInputProcessorProfiles_GetLanguageProfileDescription   12 sptr,int,sptr,sptr
#comfunc global ITfInputProcessorProfiles_GetCurrentLanguage              13 sptr
#comfunc global ITfInputProcessorProfiles_ChangeCurrentLanguage           14 int
#comfunc global ITfInputProcessorProfiles_GetLanguageList                 15 sptr,sptr
#comfunc global ITfInputProcessorProfiles_EnumLanguageProfiles            16 int,sptr
#comfunc global ITfInputProcessorProfiles_EnableLanguageProfile           17 sptr,int,sptr,int
#comfunc global ITfInputProcessorProfiles_IsEnabledLanguageProfile        18 sptr,int,sptr,sptr
#comfunc global ITfInputProcessorProfiles_EnableLanguageProfileByDefault  19 sptr,int,sptr,int
#comfunc global ITfInputProcessorProfiles_SubstituteKeyboardLayout        20 sptr,int,sptr,sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。