Método IDisplayHelp::ShowTopic (mmc.h)
O método IDisplayHelp::ShowTopic exibe o tópico de Ajuda HTML especificado no arquivo de Ajuda HTML do MMC mesclado.
Sintaxe
HRESULT ShowTopic(
[in] LPOLESTR pszHelpTopic
);
Parâmetros
[in] pszHelpTopic
Um ponteiro para uma cadeia de caracteres terminada em NULL especificando o tópico a ser exibido no arquivo de Ajuda HTML do MMC mesclado. A cadeia de caracteres deve ter o seguinte formato:
helpfilename::topicfilename
em que helpfilename é o nome do arquivo de ajuda HTML do snap-in (.chm) que o MMC mescla no arquivo de coleção de Ajuda HTML do MMC (este é apenas o nome do arquivo, não o caminho para o arquivo de Ajuda HTML original) e topicfilename é o caminho interno para o arquivo de tópico dentro do arquivo .chm do snap-in. O autor do arquivo de Ajuda HTML do snap-in determina se há uma estrutura de diretório interno para os arquivos HTML do tópico ou se todos os arquivos HTML de tópico estão na raiz do arquivo .chm.
Um snap-in informa ao MMC sobre seu arquivo .chm em sua implementação do método ISnapinHelp2::GetHelpTopic .
Por exemplo, se o snap-in tivesse o arquivo de Ajuda HTML mysnapin.chm mesclado no arquivo de coleção de Ajuda HTML do MMC e um arquivo HTML de tópico que tinha o caminho de arquivo interno de htm/help01.htm, a cadeia de caracteres teria o seguinte formulário:
mysnapin.chm::htm/help01.htm
Se, em vez disso, o arquivo de tópico help01.htm estiver na raiz do arquivo de Ajuda mysnapin.chm, a cadeia de caracteres deverá ter o seguinte formulário:
mysnapin.chm::/help01.htm
O suporte para IDs numéricas para tópicos não está incluído nas versões 1.2 e anteriores.
Valor retornado
Esse método pode retornar um desses valores.
Comentários
As versões 1.0 e 1.1 do MMC exigiam que pszHelpTopic fosse alocado com a função de API COM CoTaskMemAlloc e que o MMC liberasse a cadeia de caracteres. Isso violou as regras COM para alocação de parâmetros, que exigem que eles sejam alocados e liberados pelo chamador (o snap-in). No MMC 1.2 e no MMC 2.0, não é mais necessário que pszHelpTopic seja alocado com CoTaskMemAlloc. O chamador é livre para usar qualquer gerenciamento de memória desejado. Se o chamador optar por usar CoTaskMemAlloc, ele também será responsável por chamar CoTaskMemFree para liberar a cadeia de caracteres.
Um snap-in pode fornecer ajuda de contexto para o item selecionado manipulando a notificação de MMCN_CONTEXTHELP em seu método IComponent::Notify e chamando IDisplayHelp::ShowTopic.
Para páginas de propriedades, o snap-in deve chamar MMCPropertyHelp em vez de IDisplayHelp::ShowTopic. Como uma folha de propriedades do MMC normalmente está em execução em um thread separado, a página de propriedades não pode usar a interface IDisplayHelp diretamente. Em vez disso, a página de propriedades pode chamar MMCPropertyHelp da biblioteca MMC para obter o mesmo resultado. MMCPropertyHelp usa o mesmo parâmetro de cadeia de caracteres de tópico que IDisplayHelp::ShowTopic e manipula o marshaling da solicitação para o thread MMC main.
Se o snap-in manipular a notificação de MMCN_CONTEXTHELP , o MMC espera que o snap-in especifique um tópico da Ajuda para o item selecionado. Consequentemente, no manipulador de notificação do MMCN_CONTEXTHELP notificação, o snap-in tem duas opções:
- Ele pode chamar IDisplayHelp::ShowTopic ou MMCPropertyHelp para especificar o tópico da Ajuda e, em seguida , retornar S_OK para indicar êxito. Lembre-se de que o snap-in só deve retornar S_OK se especificar um tópico da Ajuda. Se o snap-in retornar S_OK sem especificar um tópico da Ajuda, nenhum tópico da Ajuda será exibido.
- Ele pode retornar S_FALSE à notificação. Em seguida, o MMC exibe o arquivo de coleta de ajuda com o tópico padrão do MMC selecionado.
Requisitos
| Cliente mínimo com suporte | Windows Vista |
| Servidor mínimo com suporte | Windows Server 2008 |
| Plataforma de Destino | Windows |
| Cabeçalho | mmc.h |
| DLL | Mmcndmgr.dll |