Partilhar via

Argumentos da linha de comando para o Gerenciador de Conteúdo da Ajuda

  • Artigo

Você pode especificar como implantar e gerenciar conteúdo da Ajuda local usando argumentos de linha de comando para o Gerenciador de Conteúdo da Ajuda (HlpCtntMgr.exe). Você deve executar scripts para essa ferramenta de linha de comando com permissões de administrador e não pode executar esses scripts como um serviço. Você pode realizar as seguintes tarefas usando esta ferramenta:

  • Adicionar ou atualizar o conteúdo da ajuda local de um disco ou da nuvem.

  • Remova o conteúdo da ajuda local.

  • Mova o repositório de conteúdo local da Ajuda.

  • Adicionar, atualizar, remover ou mover o conteúdo da ajuda local silenciosamente.

Sintaxe:

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

Por exemplo:

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

Observação

O nome do catálogo é VisualStudio15 tanto para o Visual Studio 2017 quanto para o Visual Studio 2019. Isso pode ser inesperado, mas isso ocorre porque o mesmo Visualizador de Ajuda é usado para ambas as versões do Visual Studio.

Opções e argumentos

A tabela a seguir define as opções e os argumentos que você pode usar a ferramenta de linha de comando para o Gerenciador de Conteúdo da Ajuda:

Comutador Necessário? Argumentos
/operation Sim - Instalar – adiciona livros de fonte de instalação especificada ao repositório de conteúdo local.
Esta opção requer o argumento /booklist ou o argumento /sourceURI, ou ambos. Se você não especificar o argumento /sourceURI, o URI do Visual Studio padrão será usado como a origem da instalação. Se você não especificar o argumento /booklist, todos os livros em /sourceUri serão instalados.
- Desinstalar – remove os livros especificado do repositório de conteúdo local.
Esta opção requer o argumento /booklist ou o argumento /sourceURI. Se você especificar o argumento /sourceURI, todos os livros serão removidos e o argumento /booklist será ignorado.
- Mover – move o repositório local para o caminho que você especificar. O caminho padrão do repositório local é definido como um diretório em %ProgramData%
Esta opção requer os argumentos /locationPath e /catalogName. As mensagens de erro serão registradas no log de eventos se você especificar um caminho que não for válido ou se não houver espaço livre na unidade para manter o conteúdo.
- Atualizar – atualiza os tópicos alterados desde que foram instalados ou atualizados mais recentemente.
Esta opção requer o argumento /sourceURI.
/catalogName Sim Especifica o nome do catálogo de conteúdo. Para o Visual Studio 2017 e o Visual Studio 2019, este é o VisualStudio15.
/locale Não Especifica a localidade do produto que é usada para exibir e gerenciar conteúdo para a instância atual do visualizador da Ajuda. Por exemplo, você especifica para EN-US inglês - Estados Unidos.

Se você não especificar uma localidade, a localidade do sistema operacional será usada. Se essa localidade não puder ser determinada, EN-US será usada.

Se você especificar uma localidade que não for válida, uma mensagem de erro será registrada no log de eventos.
/e Não Promove o Gerenciador de Conteúdo a Ajuda a Privilégios administrativos quando o usuário atual tem credenciais administrativas.
/sourceURI Não Especifica a URL da qual o conteúdo é instalado (API de Serviço) ou o caminho para o arquivo de conteúdo de instalação (.msha). O URL pode apontar para o grupo de produtos (nó a nível superior) ou para livros do produto (nó a nível folha) em um ponto de extremidade de estilo do Visual Studio 2010. Não é necessário incluir uma barra (/) no final da URL. Se você incluir uma barra à barra, ela será manipulado apropriadamente.

Uma mensagem de erro será colocada no log de eventos se você especificar um arquivo não localizado, inválido ou inacessível ou se uma conexão com a Internet não estiver disponível ou for interrompida quando o conteúdo estiver sendo gerenciado.
/vendor Não Especifica o fornecedor para o conteúdo do produto que será removido (por exemplo, Microsoft). O argumento padrão para essa opção é Microsoft.
/productName Não Especifica o nome do produto para os livros que serão removidos. O nome do produto é identificado nos arquivos helpcontentsetup.msha ou books.html que são enviados com o conteúdo. Você pode remover os livros de apenas um produto de cada vez. Para remover livros de vários produtos, você deve executar várias instalações.
/booklist Não Especifica os nomes dos livros a serem gerenciados, separados por espaços. Os valores devem corresponder aos nomes de livro conforme listado na mídia de instalação.

Se você não especificar esse argumento, todos os livros recomendados para o produto especificado em /sourceURI serão instalados.

Se o nome de um livro contiver um ou mais espaços, coloque-o entre aspas duplas (") para que a lista seja delimitada apropriadamente.

As mensagens de erro serão registradas se você especificar um /sourceURI que não for válido ou não for alcançável.
/skuId Não Especifica a unidade de manutenção de estoque (SKU) do produto da fonte de instalação, e filtra os livros que a opção de /SourceURI identifica.
/membership Não - Mínimo – instala um conjunto mínimo de conteúdo de Ajuda com base na SKU especificada usando a opção /skuId. O mapeamento entre o SKU e o conteúdo é exposto no serviço API.
- Recomendado – instala um conjunto recomendado de livros para a SKU especificada usando o argumento /skuId. A origem de instalação é a API de serviço ou .MSHA.
- Completo – instala todo o conjunto de livros para a SKU que você especifica usando o argumento /skuId. A origem de instalação é a API de serviço ou .MSHA.
/locationpath Não Especifica a pasta padrão para o conteúdo da Ajuda local. Você deve usar essa opção para instalar ou mover apenas o conteúdo. Se você especificar esta opção, também deverá especificar a opção /silent.
/silent Não Instala ou remove conteúdo da Ajuda sem avisar o usuário ou sem exibir qualquer IU, incluindo o ícone na área de notificação de status. A saída é registrada em um arquivo no diretório %Temp%. Importante: para instalar o conteúdo silenciosamente, você deve usar arquivos .cab assinados digitalmente, não arquivos .mshc.
/launchingApp Não Define o aplicativo e o contexto de catálogo quando o Visualizador da Ajuda é iniciado sem o aplicativo pai. Os argumentos para essa opção são CompanyName, ProductName e VersionNumber (por exemplo, /launchingApp Microsoft,VisualStudio,16.0).

Isso é necessário para a instalação do conteúdo com o parâmetro /silent.
/wait Seconds Não Interrompe operações de instalação, desinstalação e atualização. Se uma operação já está em andamento para o catálogo, o processo esperará até o número determinado de segundos para continuar. Use 0 para esperar indefinidamente.
/? Não Lista as opções e suas descrições para a ferramenta de linha de comando do Gerenciador de Conteúdo da Ajuda.

Códigos de saída

Quando você executa a ferramenta de linha de comando para o Gerenciador de Conteúdo da Ajuda em modo silencioso, ela retorna os seguintes códigos de saída:

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

Confira também