Método ISnapinHelp::GetHelpTopic (mmc.h)

Artigo
08/24/2023

Permite que um snap-in adicione seu arquivo de Ajuda HTML compilado ao arquivo de coleção da Ajuda do MMC.

Sintaxe

HRESULT GetHelpTopic(
  [out] LPOLESTR *lpCompiledHelpFile
);

Parâmetros

[out] lpCompiledHelpFile

Um ponteiro para o endereço da cadeia de caracteres Unicode terminada em nulo que contém o caminho do arquivo de Ajuda compilado (.chm) para o snap-in. Ao especificar o caminho, coloque o arquivo em qualquer lugar e especifique o nome do caminho completo.

Valor retornado

Esse método pode retornar um desses valores.

Comentários

O MMC chama a implementação desse método pelo snap-in para obter o local do arquivo de Ajuda do snap-in. O MMC mescla os arquivos de Ajuda HTML de todos os snap-ins com o arquivo de coleção da Ajuda HTML do console do MMC.

A hierarquia de tópicos do arquivo de Ajuda do snap-in aparecerá no sumário quando a coleção for exibida.

Ao mesclar os arquivos de Ajuda HTML, o MMC cria um único sumário, índice e recurso de pesquisa da Ajuda HTML integrado. Quando um usuário clica em Ajuda no Console de Gerenciamento da Microsoft no menu ajuda do main, o MMC abre o arquivo de Ajuda mesclado que inclui arquivos de Ajuda HTML para todos os snap-ins no arquivo de console atual.

Aloque a cadeia de caracteres lpCompiledHelpFile com a função de API COM CoTaskMemAlloc (ou o equivalente) e o MMC a liberará.

Exemplos

STDMETHODIMP CComponentData::GetHelpTopic( LPOLESTR *lpCompiledFile )
{
    LPOLESTR lpHelpFile;
 
    if ( !lpCompiledFile )
        return E_POINTER; // invalid argument
 
    lpHelpFile = (LPOLESTR) CoTaskMemAlloc( MAX_PATH * sizeof(WCHAR) );
 
    if ( !lpHelpFile )
    {
        return E_OUTOFMEMORY;
    }
 
    ExpandEnvironmentStringsW( L"%SystemRoot%\\Help\\myhelpfile.chm", lpHelpFile, MAX_PATH );
 
    *lpCompiledHelpFile = lpHelpFile;
 
    return S_OK;
}