Argumenty wiersza polecenia menedżera zawartości Pomocy
Możesz określić sposób wdrażania lokalnej zawartości Pomocy i zarządzania nią przy użyciu argumentów wiersza polecenia dla Menedżera zawartości Pomocy (HlpCtntMgr.exe). Należy uruchomić skrypty dla tego narzędzia wiersza polecenia z uprawnieniami administratora i nie można uruchomić tych skryptów jako usługi. Następujące zadania można wykonać przy użyciu tego narzędzia:
Dodaj lub zaktualizuj lokalną zawartość Pomocy z dysku lub chmury.
Usuń lokalną zawartość Pomocy.
Przenieś lokalny magazyn zawartości Pomocy.
Dodawanie, aktualizowanie, usuwanie lub przenoszenie lokalnej zawartości Pomocy w trybie dyskretnym.
Składnia:
HlpCtntmgr.exe /operation Value /catalogname CatalogName /locale Locale /sourceuri InstallationPoint
Na przykład:
hlpctntmgr.exe /operation install /catalogname VisualStudio15 /locale en-us /sourceuri d:\productDocumentation\HelpContentSetup.msha
Uwaga
Nazwa wykazu to VisualStudio15 dla programów Visual Studio 2017 i Visual Studio 2019. Może to być nieoczekiwane, ale jest to spowodowane tym, że ta sama przeglądarka pomocy jest używana w obu wersjach programu Visual Studio.
Przełączniki i argumenty
W poniższej tabeli zdefiniowano przełączniki i argumenty, których można użyć dla narzędzia wiersza polecenia dla Menedżera zawartości Pomocy:
| Switch | Wymagane? | Argumenty |
|---|---|---|
| /Operacji | Tak | - Install -- Dodaje książki z określonego źródła instalacji do lokalnego magazynu zawartości. Ten przełącznik wymaga argumentu /booklist, argumentu /sourceURI lub obu tych elementów. Jeśli nie określisz argumentu /sourceURI, domyślny identyfikator URI programu Visual Studio jest używany jako źródło instalacji. Jeśli nie określisz argumentu /booklist, zostaną zainstalowane wszystkie książki na /sourceUri. - Odinstaluj — usuwa książki określone z lokalnego magazynu zawartości. Ten przełącznik wymaga argumentu /booklist lub argumentu /sourceURI. Jeśli określisz argument /sourceURI, wszystkie książki zostaną usunięte, a argument /booklist zostanie zignorowany. - Przenieś — przenosi magazyn lokalny do określonej ścieżki. Domyślna ścieżka magazynu lokalnego jest ustawiana jako katalog w folderze %ProgramData% Ten przełącznik wymaga argumentów /locationPath i /catalogName. Komunikaty o błędach zostaną zarejestrowane w dzienniku zdarzeń, jeśli określisz ścieżkę, która nie jest prawidłowa lub jeśli dysk nie zawiera wystarczającej ilości wolnego miejsca do przechowywania zawartości. - Odśwież — Aktualizacje tematy, które uległy zmianie od czasu ich zainstalowania lub najnowszej aktualizacji. Ten przełącznik wymaga argumentu /sourceURI. |
| /catalogName | Tak | Określa nazwę wykazu zawartości. W przypadku programów Visual Studio 2017 i Visual Studio 2019 jest to VisualStudio15. |
| /Ustawień regionalnych | Nie. | Określa ustawienia regionalne produktu używane do wyświetlania zawartości bieżącego wystąpienia przeglądarki Pomocy i zarządzania nią. Można na przykład określić EN-US dla języka angielskiego Stany Zjednoczone.Jeśli nie określisz ustawień regionalnych, używane są ustawienia regionalne systemu operacyjnego. Jeśli nie można określić tych ustawień regionalnych, EN-US zostanie użyty.Jeśli określisz ustawienia regionalne, które nie są prawidłowe, w dzienniku zdarzeń zostanie zarejestrowany komunikat o błędzie. |
| /e | Nie. | Podnosi poziom Menedżera zawartości Pomocy, aby Administracja uprawnienia administracyjne, jeśli bieżący użytkownik ma poświadczenia administracyjne. |
| /Sourceuri | Nie. | Określa adres URL, z którego jest zainstalowana zawartość (interfejs API usługi) lub ścieżka do pliku instalacyjnego zawartości (msha). Adres URL może wskazywać grupę produktów (węzeł najwyższego poziomu) lub książki produktów (węzeł na poziomie liścia) w punkcie końcowym stylu programu Visual Studio 2010. Nie musisz dołączać ukośnika (/) na końcu adresu URL. Jeśli dołączysz ukośnik końcowy, zostanie on odpowiednio obsłużony. Komunikat o błędzie jest rejestrowany w dzienniku zdarzeń, jeśli określisz plik, który nie zostanie znaleziony, jest nieprawidłowy lub nie jest dostępny lub jeśli połączenie z Internetem nie jest dostępne lub zostanie przerwane podczas zarządzania zawartością. |
| /Dostawcy | Nie. | Określa dostawcę zawartości produktu, która zostanie usunięta (na przykład Microsoft). Domyślnym argumentem tego przełącznika jest firma Microsoft. |
| /Productname | Nie. | Określa nazwę produktu dla książek, które zostaną usunięte. Nazwa produktu jest identyfikowana w plikach helpcontentsetup.msha lub books.html dostarczanych z zawartością. Książki można usuwać tylko z jednego produktu jednocześnie. Aby usunąć książki z wielu produktów, należy wykonać wiele instalacji. |
| /booklist | Nie. | Określa nazwy książek, które mają być zarządzane, oddzielone spacjami. Wartości muszą być zgodne z nazwami książek wymienionymi na nośniku instalacyjnym. Jeśli nie określisz tego argumentu, zostaną zainstalowane wszystkie zalecane książki dla określonego produktu w identyfikatorze /sourceURI. Jeśli nazwa książki zawiera co najmniej jedną spację, umieść ją z podwójnymi cudzysłowymi ("), tak aby lista była odpowiednio rozdzielana. Komunikaty o błędach zostaną zarejestrowane, jeśli określisz /sourceURI, który nie jest prawidłowy lub nie jest osiągalny. |
| /skuId | Nie. | Określa jednostkę przechowywania zapasów (SKU) produktu ze źródła instalacji i filtruje książki identyfikowane przez przełącznik /SourceURI. |
| /Członkostwa | Nie. | - Minimum — instaluje minimalny zestaw zawartości Pomocy na podstawie jednostki SKU określonej przy użyciu przełącznika /skuId. Mapowanie między jednostkami SKU i zestawem zawartości jest uwidocznione w interfejsie API usługi. - Zalecane — instaluje zestaw zalecanych książek dla jednostki SKU określonej przy użyciu argumentu /skuId. Źródłem instalacji jest interfejs API usługi lub . MSHA. - Pełna — instaluje cały zestaw książek dla jednostki SKU określonej przy użyciu argumentu /skuId. Źródłem instalacji jest interfejs API usługi lub . MSHA. |
| /locationpath | Nie. | Określa folder domyślny dla lokalnej zawartości Pomocy. Należy użyć tego przełącznika tylko do zainstalowania lub przeniesienia zawartości. Jeśli określisz ten przełącznik, musisz również określić /silent switch. |
| /silent | Nie. | Instaluje lub usuwa zawartość Pomocy bez monitowania użytkownika ani wyświetlania dowolnego interfejsu użytkownika, w tym ikony w obszarze powiadomień o stanie. Dane wyjściowe są rejestrowane w pliku w katalogu %Temp% . Ważne: aby zainstalować zawartość w trybie dyskretnym, należy użyć plików cab podpisanych cyfrowo, a nie plików mshc. |
| /launchingApp | Nie. | Definiuje kontekst aplikacji i katalogu, gdy przeglądarka Pomocy jest uruchamiana bez aplikacji nadrzędnej. Argumenty tego przełącznika to CompanyName, ProductName i VersionNumber (na przykład /launchingApp Microsoft,VisualStudio,16.0).Jest to wymagane do instalowania zawartości z /silent parametru. |
| /wait s | Nie. | Wstrzymuje operacje instalacji, odinstalowywania i odświeżania. Jeśli operacja jest już w toku dla wykazu, proces będzie czekać do określonej liczby sekund, aby kontynuować. Użyj 0, aby poczekać na czas nieokreślony. |
| /? | Nie. | Wyświetla listę przełączników i ich opisy dla narzędzia wiersza polecenia dla Menedżera zawartości Pomocy. |
Kody zakończenia
Po uruchomieniu narzędzia wiersza polecenia dla Menedżera zawartości Pomocy w trybie dyskretnym zwraca następujące kody zakończenia:
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.)