Win32 API 日本語リファレンス
ホーム › Globalization › IUserDictionariesRegistrar

IUserDictionariesRegistrar

COM
📘 Microsoft Learn (日本語) · English
IIDaa176b85-0e12-4844-8e1a-eef1da77f586継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

ユーザー辞書の登録を管理します。

解説(Remarks)

IUserDictionariesRegistrar を使用すると、クライアントは通常の辞書パス(%AppData%\Microsoft\Spelling)以外の場所に存在するユーザー辞書ファイルを永続的に登録および登録解除できます。辞書は通常のパスにあるものと同じファイル形式を持ち、適切なファイル拡張子を持っている必要があります。 ただし、可能な限りクライアントは辞書を %AppData%\Microsoft\Spelling 配下に配置することを強く推奨します。スペルチェック機能は、そのディレクトリツリー外の辞書の変更を検出しません。

このインターフェイスは、ISpellCheckerFactory に対する QueryInterface によって取得します。

登録されたすべての辞書ファイルの合計サイズは、既定で 1 MB 未満でなければなりません。これは、レジストリキー HKEY_CURRENT_USER\Software\Microsoft\Spelling\Dictionaries\AllowBiggerUD に値 1 を設定することで 2 MB まで増やすことができます。Windows レジストリの詳細については、レジストリを参照してください。

メソッド 2

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

vtbl 3 HRESULT RegisterUserDictionary(LPWSTR dictionaryPath, LPWSTR languageTag)

登録解除されるまで、現在のユーザーのユーザー辞書として使用するファイルを登録します。

dictionaryPathLPWSTRin登録する辞書ファイルのパス。
languageTagLPWSTRinこの辞書を使用する言語。空のままにすると、任意の言語で使用されます。

戻り値

このメソッドは、次のいずれかの値を返すことができます。

戻り値 説明
S_OK
 成功しました。
S_FALSE
 そのファイルは、その言語に対して既に登録されています。
E_INVALIDARG
 ファイルが存在しないか無効であるか、または有効な拡張子(.dic、.exc、.acl)を持っていません。
E_POINTER
 dictionaryPath または languageTag が null ポインターです。

解説(Remarks)

ファイル名は、拡張子 .dic(追加された単語)、.exc(除外された単語)、または .acl(オートコレクトの単語ペア)を持つ必要があります。ファイルは UTF-16 LE のプレーンテキストであり、適切なバイト順マーク(BOM)で始まる必要があります。 各行には、単語(追加単語リストおよび除外単語リストの場合)、または縦棒("|")で区切られた単語からなるオートコレクトのペア(オートコレクト単語リストの場合)が含まれます。辞書が含まれる単語リストは、ファイル拡張子から推測されます。

言語サブタグに対して登録されたファイルは、それを含むすべての言語で使用されます。たとえば、"en" に対して登録された辞書は、"en-US" のスペルチェッカーでも使用されます。

vtbl 4 HRESULT UnregisterUserDictionary(LPWSTR dictionaryPath, LPWSTR languageTag)

以前に登録されたユーザー辞書の登録を解除します。

dictionaryPathLPWSTRin登録解除する辞書ファイルのパス。
languageTagLPWSTRinこの辞書が使用されていた言語。RegisterUserDictionary に渡された言語と一致している必要があります。

戻り値

このメソッドは、次のいずれかの値を返すことができます。

戻り値 説明
S_OK
 成功しました。
E_POINTER
 dictionaryPath または languageTag が null ポインターです。

解説(Remarks)

注意 指定したファイルの登録を解除するには、そのファイルを登録するときに以前使用したものと同じ引数をこのメソッドに渡す必要があります。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IUserDictionariesRegistrar "{AA176B85-0E12-4844-8E1A-EEF1DA77F586}"
#usecom global IUserDictionariesRegistrar IID_IUserDictionariesRegistrar "{}"
#comfunc global IUserDictionariesRegistrar_RegisterUserDictionary    3 wstr,wstr
#comfunc global IUserDictionariesRegistrar_UnregisterUserDictionary  4 wstr,wstr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。