ヘルプ コンテンツ マネージャーのコマンド ライン引数Command-Line Arguments for the Help Content Manager

ヘルプ コンテンツ マネージャー (HlpCtntMgr.exe) のコマンド ライン引数を使用して、ローカル ヘルプ コンテンツを配置および管理する方法を指定できます。You can specify how to deploy and manage local Help content by using command-line arguments for Help Content Manager (HlpCtntMgr.exe). 管理者のアクセス許可でこのコマンド ライン ツールのスクリプトを実行する必要があり、これらのスクリプトをサービスとして実行することはできません。You must run scripts for this command-line tool with administrator permissions, and you can't run these scripts as a service. このツールを使用して、以下のタスクを実行できます。You can perform the following tasks by using this tool:

  • ディスクまたはクラウドのローカル ヘルプ コンテンツを追加または更新します。Add or update local Help content from a disk or the cloud.

  • ローカル ヘルプ コンテンツを削除します。Remove local Help content.

  • ローカル ヘルプ コンテンツ ストアを移動します。Move the local Help content store.

  • ローカル ヘルプ コンテンツを、サイレント モードで追加、更新、削除、または移動します。Add, update, remove, or move local Help content silently.

構文:Syntax:

HlpCtntmgr.exe /operation Value /catalogname CatalogName /locale Locale /sourceuri InstallationPoint  

次に例を示します。For example:

hlpctntmgr.exe /operation install /catalogname VisualStudio15 /locale en-us /sourceuri d:\productDocumentation\HelpContentSetup.msha  

スイッチおよび引数Switches and Arguments

次の表に、ヘルプ コンテンツ マネージャーのコマンド ライン ツールで使用できるスイッチと引数の定義を示します。The following table defines the switches and arguments that you can use for the command-line tool for Help Content Manager:

切り替えSwitch 必須?Required? 引数Arguments
/operation/operation はいYes - Install -- 指定されたインストール ソースからローカル コンテンツ ストアにブックを追加します。- Install--Adds books from the specified installation source to the local content store.
このスイッチには、/booklist 引数、/sourceURI 引数、または両方が必要です。This switch requires the /booklist argument, the /sourceURI argument, or both. /sourceURI 引数を指定しない場合、Visual Studio の既定の URI がインストール ソースとして使用されます。If you don't specify the /sourceURI argument, the default Visual Studio URI is used as the installation source. /booklist 引数を指定しない場合、/sourceUri のすべてのブックがインストールされます。If you don't specify the /booklist argument, all books on the /sourceUri are installed.
- Uninstall -- 指定するブックをローカル コンテンツ ストアから削除します。- Uninstall--Removes the books that you specify from the local content store.
このスイッチには、/booklist 引数または /sourceURI 引数が必要です。This switch requires the /booklist argument or the /sourceURI argument. /sourceURI 引数を指定すると、すべてのブックが削除され、/booklist 引数は無視されます。If you specify the /sourceURI argument, all books are removed, and the /booklist argument is ignored.
- Move -- 指定するパスにローカル ストアを移動します。- Move--Moves the local store to the path that you specify. 既定のローカル ストア パスは、%ProgramData% 下のディレクトリとして設定されます。The default local store path is set as a directory under %ProgramData%
このスイッチには、/locationPath 引数と /catalogName 引数が必要です。This switch requires the /locationPath and /catalogName arguments. 有効でないパスを指定した場合、またはドライブにコンテンツを保持するのに十分な空き領域がない場合は、エラー メッセージがイベント ログに記録されます。Error messages will be logged in the event log if you specify a path that isn't valid or if the drive doesn't contain enough free space to hold the content.
- Refresh -- インストール後または最近の更新後に変更されたトピックを更新します。- Refresh--Updates topics that have changed since they were installed or most recently updated.
このスイッチには /sourceURI 引数が必要です。This switch requires the /sourceURI argument.
/catalogName/catalogName はいYes コンテンツ カタログの名前を指定します。Specifies the name of the content catalog.
/locale/locale No ヘルプ ビューアーの現在のインスタンスのコンテンツを表示および管理するために使用される製品ロケールを指定します。Specifies the product locale that's used to view and manage content for the current instance of the Help viewer. たとえば、英語-米国の場合は EN-US を指定します。For example, you specify EN-US for English-United States.

ロケールを指定しない場合、オペレーティング システムのロケールが使用されます。If you don't specify a locale, the locale of the operating system is used. そのロケールを特定できない場合、EN-US が使用されます。If that locale can't be determined, EN-US is used.

有効でないロケールを指定した場合は、エラー メッセージがイベント ログに記録されます。If you specify a locale that isn't valid, an error message is logged in the event log.
/e/e いいえNo 現在のユーザーに管理者資格情報がある場合は、ヘルプ コンテンツ マネージャーを管理特権に昇格させます。Elevates the Help Content Manager to Administrative priviledges if the current user has administrative credentials.
/sourceURI/sourceURI いいえNo コンテンツのインストール元の URL (サービス API)、またはコンテンツ インストール ファイル (.msha) へのパスを指定します。Specifies the URL from which content is installed (Service API) or the path to the content installation file (.msha). URL は、Visual Studio 2010 スタイルのエンドポイントの製品グループ (最上位のノード)、または製品ブック (リーフ レベル ノード) を指すことができます。The URL can point to the Product Group (top-level node) or to the Product Books (leaf-level node) in a Visual Studio 2010 style endpoint. URL の最後にスラッシュ (/) を含める必要はありません。You don't need to include a slash (/) at the end of the URL. 後続のスラッシュを含めた場合も適切に処理されます。If you do include a trailing slash, it will be handled appropriately.

見つからないファイルや有効でないファイル、アクセスできないファイルを指定した場合、またはインターネットへの接続が使用できないか、コンテンツの管理中に中断した場合は、エラー メッセージがイベント ログに記録されます。An error message is logged in the event log if you specify a file that isn't found, isn't valid, or isn't accessible or if a connection to the Internet isn't available or is interrupted while content is being managed.
/vendor/vendor いいえNo 削除される製品コンテンツの販売元 (Microsoft など) を指定します。Specifies the vendor for the product content that will be removed (for example, Microsoft). このスイッチの既定の引数は Microsoft です。The default argument for this switch is Microsoft.
/productName/productName いいえNo 削除されるブックの製品名を指定します。Specifies the product name for the books that will be removed. 製品名は、コンテンツに付属する helpcontentsetup.msha または books.html ファイルに示されています。The product name is identified in the helpcontentsetup.msha or books.html files that shipped with the content. 一度に 1 つの製品からのみブックを削除できます。You can remove books from only one product at a time. 複数の製品からブックを削除するには、複数のインストールを実行する必要があります。To remove books from multiple products, you must perform multiple installations.
/booklist/booklist いいえNo 管理するブックの名前をスペースで区切って指定します。Specifies the names of the books to be managed, separated by spaces. 値は、インストール メディアに示されたブック名と一致する必要があります。Values must match the book names as listed on the installation media.

この引数を指定しない場合、/sourceURI で指定された製品の推奨されるブックがすべてインストールされます。If you don't specify this argument, all recommended books for the specified product in the /sourceURI are installed.

ブック名にスペースが 1 つ以上含まれている場合は、リストが適切に区切られるようにブック名を二重引用符 (") で囲みます。If the name of a book contains one or more spaces, surround it with double quotes (") so that the list is delimited appropriately.

有効でないか到達可能でない /sourceURI を指定した場合は、エラー メッセージが記録されます。Error messages will be logged if you specify a /sourceURI that isn't valid or isn't reachable.
/skuId/skuId いいえNo インストール ソースから製品の在庫管理単位 (SKU) を指定し、/SourceURI スイッチで識別されるブックにフィルターを適用します。Specifies the stock keeping unit (SKU) of the product from the installation source, and filters books that the /SourceURI switch identifies.
/membership/membership No - Minimum -- /skuId スイッチで指定する SKU に基づいて、最小限のヘルプ コンテンツ セットをインストールします。- Minimum-- Installs a minimum set of Help content based on the SKU that you specify by using the /skuId switch. SKU とコンテンツ セットの間のマッピングは、サービス API で公開されます。The mapping between the SKU and the content set is exposed in the Service API.
- Recommended -- /skuId 引数で指定する SKU の推奨ブック セットをインストールします。- Recommended—Installs a set of recommended books for the SKU that you specify by using the /skuId argument. インストール ソースは、サービス API または .MSHA です。The Installation source is the service API or .MSHA.
- Full -- /skuId 引数で指定する SKU のすべてのブック セットをインストールします。- Full-- Installs the entire set of books for the SKU that you specify by using the /skuId argument. インストール ソースは、サービス API または .MSHA です。The Installation source is the service API or .MSHA.
/locationpath/locationpath いいえNo ローカル ヘルプ コンテンツの既定のフォルダーを指定します。Specifies the default folder for local Help content. このスイッチは、コンテンツをインストールまたは移動する場合にのみ使用する必要があります。You must use this switch only to install or move content. このスイッチを指定する場合は、/silent スイッチも指定する必要があります。If you specify this switch, you must also specify the /silent switch.
/silent/silent いいえNo ユーザーに確認せずに、または状態通知領域のアイコンなどの UI を表示せずに、ヘルプ コンテンツをインストールまたは削除します。Installs or removes Help content without prompting the user or displaying any UI, including the icon in the status notification area. %Temp% ディレクトリ内のファイルに出力が記録されます。Output is logged to a file in the %Temp% directory. 重要: コンテンツをサイレント モードでインストールするには、.mshc ファイルではなく、デジタル署名された .cab ファイルを使用する必要があります。Important: To install content silently, you must use digitally signed .cab files, not .mshc files.
/launchingApp/launchingApp いいえNo ヘルプ ビューアーが親アプリケーションなしで起動されるときのアプリケーションおよびカタログ コンテキストを定義します。Defines the application and catalog context when the Help viewer is launched without the parent application. このスイッチの引数は、CompanyNameProductName、および VersionNumber です (例: /launchingApp Microsoft,VisualStudio,15.0)。The arguments for this switch are CompanyName, ProductName, and VersionNumber (for example, /launchingApp Microsoft,VisualStudio,15.0).

これは、/silent パラメーター付きでコンテンツをインストールするために必要です。This is required for installing content with the /silent parameter."
/wait 秒数/wait Seconds No インストール、アンインストール、および更新操作を一時停止します。Pauses install, uninstall, and refresh operations. 操作が既にカタログに対して進行中の場合、プロセスは特定の秒数が経過するまで続行を待機します。If an operation is already in progress for the catalog, the process will wait up to the given number of seconds to continue. 無期限に待機するには 0 を使用します。Use 0 to wait indefinitely.
/?/? いいえNo ヘルプ コンテンツ マネージャーのコマンド ライン ツールのスイッチとその説明を一覧表示します。Lists the switches and their descriptions for the command-line tool for Help Content Manager.

終了コードExit Codes

ヘルプ コンテンツ マネージャーのコマンド ライン ツールをサイレント モードで実行すると、次の終了コードが返されます。When you run the command-line tool for the Help Content Manager in silent mode, it returns the following exit codes:

Success = 0,  

FailureToElevate = 100  
InvalidCmdArgs = 101,  
FailOnFetchingOnlineContent = 110,  
FailOnFetchingContentFromDisk = 120,  
FailOnFetchingInstalledBooks = 130,  
NoBooksToUninstall = 200,  
NoBooksToInstall = 300,  
FailOnUninstall = 400,  
FailOnInstall = 500,  
FailOnMove = 600,  
FailOnUpdate = 700,  
FailOnRefresh = 800,  
Cancelled = 900,  
Others = 999,  
ContentManagementDisabled = 1200,  
OnlineHelpPreferenceDisabled = 1201  
UpdateAlreadyRunning = 1300 - (Signals that the update didn't run because another was in progress.)

関連項目See also

ヘルプ ビューアーの管理者ガイドHelp Viewer Administrator Guide
ヘルプ コンテンツ マネージャーのオーバーライドHelp Content Manager Overrides
Microsoft Help ViewerMicrosoft Help Viewer