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

Artículo
08/24/2023

Permite que un complemento agregue su archivo de ayuda HTML compilado al archivo de colección de ayuda MMC.

Sintaxis

HRESULT GetHelpTopic(
  [out] LPOLESTR *lpCompiledHelpFile
);

Parámetros

[out] lpCompiledHelpFile

Puntero a la dirección de la cadena Unicode terminada en null que contiene la ruta de acceso del archivo de Ayuda compilado (.chm) para el complemento. Al especificar la ruta de acceso, coloque el archivo en cualquier lugar y especifique el nombre de la ruta de acceso completa.

Valor devuelto

Este método puede devolver uno de estos valores.

Comentarios

MMC llama a la implementación del complemento de este método para obtener la ubicación del archivo de ayuda del complemento. MMC combina los archivos de ayuda HTML de todos los complementos con el archivo de colección de ayuda HTML de la consola MMC.

La jerarquía de temas del archivo de Ayuda del complemento aparecerá en la tabla de contenido cuando se vea la colección.

Al combinar los archivos de Ayuda HTML, MMC crea una única tabla de contenido, índice y búsqueda de ayuda HTML integrada. Cuando un usuario hace clic en Ayuda en Microsoft Management Console en el menú ayuda principal, MMC abre el archivo de Ayuda combinado que incluye archivos de Ayuda HTML para todos los complementos del archivo de consola actual.

Asigne la cadena lpCompiledHelpFile con la función de API COM CoTaskMemAlloc (o equivalente) y MMC lo liberará.

Ejemplos

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;
}