ヘルプ ビューアーの既定値をオーバーライドする

Visual Studio IDE の Microsoft ヘルプ ビューアーとヘルプ関連機能の既定の動作を変更できます。

ヘルプ コンテンツ マネージャーは、ローカル ヘルプ ビューアー コンテンツの展開と管理に使用できるツールです。 ヘルプ ビューアーの動作を変更するには、ヘルプ コンテンツ マネージャー実行可能プログラム HlpCtntMgr.exe の既定の設定をオーバーライドできます。

ヘルプ コンテンツ マネージャーのオプションはさまざまな方法で設定できます。

• .pkgdef ファイルを作成してレジストリ キーの値を設定します。
• レジストリでオプションを直接設定します。

.pkgdef ファイルを使用してヘルプ ビューアーの動作を変更する

.pkgdef ファイルには、ヘルプ ビューアーで使用される構成情報が格納されます。 .pkgdef ファイルを使用して、次の表に一覧表示するレジストリ キーの値を調整できます。

レジストリ キー値	Type	データ	説明
NewContentAndUpdateService	string	<サービス エンドポイントの URL>	一意のサービス エンドポイントを定義する
UseOnlineHelp	dword	ローカルのヘルプを指定するには 0、オンライン ヘルプを指定するには 1	オンライン ヘルプまたはオフライン ヘルプの既定を定義する
OnlineBaseUrl	string	<サービス エンドポイントの URL>	一意の F1 エンドポイントを定義する
OnlineHelpPreferenceDisabled	dword	オンライン ヘルプの設定オプションを有効にするには 0、無効にするには 1	オンライン ヘルプの設定オプションを無効にする
DisableManageContent	dword	ヘルプ ビューアーの [コンテンツの管理] タブを有効にするには0、無効にするには 1	[コンテンツの管理] タブを無効にする
DisableFirstRunHelpSelection	dword	Visual Studio を初めて起動する際に構成されるヘルプ機能を有効にするには 0、無効にするには 1	Visual Studio を初めて起動する際にコンテンツのインストールを無効にする

.pkgdef ファイルでレジストリ キーの値を設定するには、次の手順に従います。

1. 新しいファイルを作成し、拡張子 .pkgdef を指定します。

2. ファイルの最初の行に次のテキストを追加します。

   [$RootKey$\Help]

3. 別の行に、上記の表で説明したレジストリ キー値のいずれかを追加します。 たとえば、次の行を追加して UseOnlineHelp 値を構成できます。

   "UseOnlineHelp"=dword:00000001

4. このファイルを、Visual Studio のインストールの CommonExtensions フォルダーにコピーします。 次に例を示します。

   • Visual Studio 2017 の Community Edition を使用する場合は、次のフォルダーに .pkgdef ファイルを追加します。

     C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\CommonExtensions

   • Visual Studio 2022 の Community Edition を使用する場合は、次のフォルダーに .pkgdef ファイルを追加します。

     C:\Program Files\Microsoft Visual Studio\2022\Community\Common7\IDE\CommonExtensions

5. 開発者コマンド プロンプトで、次のコマンドを実行します。

   devenv /updateconfiguration

.pkgdef ファイルの内容の例

[$RootKey$\Help]
"NewContentAndUpdateService"="https://some.service.endpoint"
"UseOnlineHelp"=dword:00000001
"OnlineBaseUrl"="https://some.service.endpoint"
"OnlineHelpPreferenceDisabled"=dword:00000000
"DisableManageContent"=dword:00000000
"DisableFirstRunHelpSelection"=dword:00000001

レジストリ エディターを使用してヘルプ ビューアーの動作を変更する

レジストリ エディターでレジストリ キーの値を設定することで、次の種類の動作を制御できます。

タスク	レジストリ キー	値	Data
Override BITS ジョブの優先順位をオーバーライドする	HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node (64-bit コンピューターの場合)\Microsoft\Help\v2.3	BITSPriority	foreground、high、normal、または low
ネットワーク共有上のローカル コンテンツ ストアを指定する	HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Help\ v2.3\Catalogs\VisualStudio15	LocationPath	ContentStoreNetworkShare

関連するコンテンツ

• ヘルプ ビューアーの管理者ガイド
• ヘルプ コンテンツ マネージャーのコマンド ライン引数
• Microsoft Help Viewer