Аргументы командной строки для диспетчера содержимого справки
Можно указать способ развертывания и управления локальным содержимым справки с помощью аргументов командной строки для диспетчера содержимого справки (HlpCtntMgr.exe). Сценарии для этого средства командной строки необходимо выполнять с разрешениями администратора, кроме того, невозможно выполнить эти сценарии в качестве службы. С помощью этого средства можно выполнить следующие задачи.
Добавление или обновление локального содержимого справки с диска или из облака.
Удаление локального содержимого справки.
Перемещение хранилища содержимого локальной справки.
Добавление, обновление, удаление или перемещение локального содержимого справки в автоматическом режиме.
Синтаксис
HlpCtntmgr.exe /operation Value /catalogname CatalogName /locale Locale /sourceuri InstallationPoint
Рассмотрим пример.
hlpctntmgr.exe /operation install /catalogname VisualStudio15 /locale en-us /sourceuri d:\productDocumentation\HelpContentSetup.msha
Примечание.
Имя каталога — VisualStudio15 для Visual Studio 2017 и Visual Studio 2019. Это может быть неожиданно, но это связано с тем, что для обеих версий Visual Studio используется один и тот же средство просмотра справки.
Параметры и аргументы
В следующей таблице определены параметры и аргументы, которые можно использовать для средства командной строки для диспетчера содержимого справки:
| Switch | Обязательное? | Аргументы |
|---|---|---|
| /operation | Да | - Установить. Добавляет книги из определенного источника установки в хранилище локального содержимого. Этот ключ требует аргумента /booklist, аргумента /sourceURI или и того, и другого. Если не указан аргумент /sourceURI, то URI Visual Studio по умолчанию используется в качестве источника установки. Если не указан аргумент /booklist, устанавливаются все книги из /sourceUri. - Удалить. Удаляет указанные книги из локального хранилища содержимого. Этот ключ требует аргумента /booklist или /sourceURI. Если указан аргумент /sourceURI, удаляются все книги, а аргумент /booklist игнорируется. - Переместить. Перемещает локальное хранилище в указанный путь. В качестве локального пути хранения по умолчанию задается каталог в %ProgramData% Этот параметр требует аргументов /locationPath и /catalogName. Сообщения об ошибке будут записаны в журнал событий при указании пути, который недопустим, или если на диске недостаточно свободного пространства для хранения содержимого. - Обновить. Обновляет разделы, которые были изменены с момента установки или последнего обновления. Этот параметр требует аргумента /sourceURI. |
| /catalogName | Да | Указывает имя каталога содержимого. Для Visual Studio 2017 и Visual Studio 2019 это VisualStudio15. |
| /locale | No | Задает языковой стандарт продукта, который используется для просмотра и управления содержимым текущего экземпляра средства просмотра справки. Например, для английского языка в США указывается EN-US.Если языковой стандарт не задан, используется языковой стандарт операционной системы. Если этот языковой стандарт не может быть определен, используется EN-US.Если указан языковой стандарт, который недопустим, сообщение об ошибке выводится в журнал событий. |
| /e | No | Расширяет полномочия диспетчера содержимого справки до прав администратора, если текущий пользователь имеет учетные данные администратора. |
| /sourceURI | No | Указывает URL-адрес, с которого устанавливается содержимое (API службы), или путь к файлу установки содержимого (MSHA). URL-адрес может указывать на группу продуктов (узел верхнего уровня) или на книги продукта (узел конечного уровня) в конечной точке в стиле Visual Studio 2010. Нет необходимости включать косую черту (/) в конце URL-адреса. При включении косой черты, она будет обработана соответствующим образом. Сообщение об ошибке регистрируется в журнале событий, если указан файл, который не найден, является недопустимым или недоступен, либо если подключение к Интернету недоступно или прерывается, пока выполняется управление содержимым. |
| /vendor | No | Указывает поставщика для содержимого продукта, которое будет удаляться (например, Microsoft). Аргумент по умолчанию для этого ключа — Microsoft. |
| /productName | No | Задает имя продукта для удаляемых книг. Имя продукта определяется файлом helpcontentsetup.msha или books.html, поставляемым вместе с содержимым. Можно удалить книги только из одного продукта за раз. Чтобы удалить книги из нескольких продуктов, необходимо выполнить несколько установок. |
| /booklist | No | Задает имена книг для управления, разделенные пробелами. Значения должны совпадать с именами книг, как они перечислены на установочном носителе. Если не указать этот аргумент, устанавливаются все рекомендованные книги для заданного продукта в /sourceURI. Если имя книги содержит один пробел или несколько, окружите его двойными кавычками ("), чтобы список был разделен соответствующим образом. Сообщения об ошибках записываются в журнал при определении /sourceURI, который является недопустимым или не доступен. |
| /skuId | No | Определяет единицу складского хранения (SKU) продукта из источника установки и фильтрует книги, определяемые параметром /SourceURI. |
| /membership | No | - Минимальная. Установит минимальный набор содержимого справки на основе SKU, заданного с помощью параметра /skuId. Сопоставление между SKU и набором содержимого представляется в API службы. - Рекомендуемая. Установит набор рекомендованных книг для SKU, заданной с помощью аргумента /skuId. Источник установки — API службы или MSHA. - Полная. Установит весь набор книг для номера SKU, заданного с помощью аргумента /skuId. Источник установки — API службы или MSHA. |
| /locationpath | No | Задает папку по умолчанию для локального содержимого справки. Необходимо использовать этот параметр только для установки или перемещения содержимого. При указании этого параметра необходимо также указать параметр /silent. |
| /silent | No | Устанавливает или удаляет содержимое справки без отображения запросов для пользователя и какого-либо пользовательского интерфейса, включая значок в области уведомлений о состоянии. Выходные данные записываются в файл в каталоге %Temp%. Важно. Для установки содержимого в автоматическом режиме необходимо использовать подписанные CAB-файлы, а не MSHC-файлы. |
| /launchingApp | No | Определяет приложение и контекст каталога, когда средство просмотра справки запускается без родительского приложения. Для этого параметра допустимы следующие аргументы: CompanyName, ProductName и VersionNumber (например, /launchingApp Microsoft,VisualStudio,16.0).Это необходимо для установки содержимого с параметром /silent. |
| /wait сек. | No | Приостанавливает операции установки, удаления и обновления. Если операция уже выполняется для каталога, процесс ожидает указанное число секунд для продолжения. Для ожидания без ограничений используйте значение "0". |
| /? | No | Перечисляет параметры и их описания для средства командной строки для диспетчера содержимого справки. |
Коды выхода
При запуске средства командной строки для диспетчера содержимого справки в автоматическом режиме оно возвращает следующие коды завершения.
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.)