Help Content Manager 的命令列引數

 

如需 Visual Studio 2017 的最新文件請參閱 Visual Studio 2017 文件

您可以使用說明內容管理員 (HlpCtntmgr.exe) 的命令列引數來指定如何部署和管理本機說明內容。 您必須以系統管理員權限來執行命令列工具的指令碼,您無法以服務方式執行這些指令碼。 使用本工具可執行下列工作:

  • 從磁碟或雲端新增或更新本機說明內容。

  • 移除本機說明內容。

  • 移動本機說明內容的存放區。

  • 以無訊息模式加入、更新、移除或移動本機說明內容。

語法:

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

例如:

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

下表定義的參數和引數可讓您在 Help Content Manager 的命令列工具使用:

參數是否為必要項?引數
/operation- 安裝 -- 從指定的安裝來源將書籍加入至本機的內容存放區。
這個參數需要 /booklist 引數或 /sourceURI 引數,或是兩者同時使用。 如果您沒有指定 /sourceURI 引數,則會把預設的 Visual Studio URI 當成安裝來源。 如果您未指定 /booklist 引數,就會安裝 /sourceUri 上的所有書籍。
- 解除安裝 -- 移除您從本機內容存放區指定的書籍。
這個參數需要 /booklist 引數或 /sourceURI 引數。 如果您指定 /sourceURI 引數,則會移除所有書籍,並會忽略 /booklist 引數。
- 移動 -- 將本機存放區移至您指定的路徑。 預設本機存放區路徑是由 %PROGRAMDATA% 之下的說明安裝程式所設定
這個參數需要 /locationPath 和 /catalogName 引數。 如果您指定無效的路徑或磁碟機未包含足夠的可用空間來容納內容,錯誤訊息將被記錄在事件記錄檔中。
- 重新整理 -- 更新已變更的主題,因為它們已安裝或最近更新過。
這個參數需要 /sourceURI 引數。
/catalogName指定內容目錄的名稱。
/locale指定產品地區設定,此設定用來檢視並管理目前執行個體的說明檢視器內容。 例如,您指定 EN-US 英文 - 美國。

如果您未指定地區設定,就會使用作業系統的地區設定。 如果無法判斷該地區設定,就會使用 EN-US

如果您指定無效的地區設定,則錯誤訊息會記錄在事件記錄檔。
/e如果目前使用者具有系統管理認證,則將 Help Content Manager 的權限提高為系統管理權限。
/sourceURI指定安裝內容 (服務應用程式開發介面) 的 URL 或內容安裝檔案 (.msha) 的路徑。 在 Visual Studio 2010 樣式端點中,URL 可以指向產品群組 (最上層節點) 或產品書籍 (分葉層級節點)。 您不需要包含 URL 結尾的斜線 (/)。 如果您包含結尾斜線,則它會受到適當地處理。

當內容正受到管理時,如果找不到您指定的檔案、或其無效或無法存取,或網際網路連線無法使用或遭中斷,錯誤訊息會記錄在事件記錄檔。
/vendor指定要移除的產品內容廠商 (例如, Microsoft)。 這個參數的預設引數是 Microsoft。
/productName指定要移除的書籍產品名稱。 可在隨附於內容中的 helpcontentsetup.msha 或 books.html 檔案裡識別產品名稱。 您一次只能從一項產品中移除書籍。 若要從多個產品中移除書籍,您必須執行多個安裝。
/booklist指定要受管理的書籍名稱,以空格分隔。 值必須符合安裝媒體上所列的書籍名稱。

若您沒有指定這個引數,當安裝來源是 Visual Studio 2012 格式時,將安裝在 /sourceURI 中所有建議的指定產品書籍。

如果書籍名稱包含 1 或多個空格,請用雙引號 (") 括住,以便適當地分隔清單。

如果您指定無效或無法連接的 /sourceURI ,就會記錄下錯誤訊息。
/skuId從安裝來源指定產品的庫存單位 (SKU),並篩選 /SourceURI 參數識別的書籍。
/membership- 最低 -- 會根據您使用 /skuId 參數指定的 SKU 安裝最小一組的說明內容。 SKU 和內容集之間的對應會被公開到服務應用程式開發介面中。
- 建議 -- 針對您使用 /skuId 引數指定的 SKU 安裝一組推薦的書籍。 安裝來源是服務應用程式開發介面或 .MSHA。
- -- 針對您使用 /skuId 引數指定的 SKU 安裝一組完整的書籍。 安裝來源是服務應用程式開發介面或 .MSHA。
/locationpath指定本機說明內容的預設資料夾。 您只能用這個參數安裝或移動內容。 如果您指定這個參數,則您也必須指定 /silent 參數。
/silent安裝或移除說明內容,而不提示使用者,或顯示任何包括狀態通知區域中圖示的 UI。 輸出會被記錄在 %Temp% 目錄中的檔案。 Important: 若要以無訊息方式安裝內容,您必須使用數位簽署的 .cab 檔,而非 .mshc 檔案。
/launchingApp在沒有父應用程式時啟動說明檢視器,請定義應用程式和目錄的內容。 此參數的引數是 CompanyNameProductNameVersionNumber (例如 /launchingApp Microsoft,VisualStudio,11.0)。

若要使用 /silent 參數安裝內容,這是必要的。
/wait 暫停安裝、解除安裝和重新整理作業。 如果已經為了目錄而正在進行作業,處理序會在等候指定的秒數後繼續。 指定 0 會無限期等待。
/?列出 Help Content Manager 命令列工具的參數及描述。

結束代碼

當您以無訊息模式執行 Help Content Manager 的命令列工具時,它會傳回下列結束代碼:

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.)  
  

說明檢視器系統管理員指南
Help Content Manager 覆寫設定

顯示: