Método IDisplayHelp::ShowTopic (mmc.h)
El método IDisplayHelp::ShowTopic muestra el tema de ayuda HTML especificado en el archivo de ayuda HTML DE MMC combinado.
Sintaxis
HRESULT ShowTopic(
[in] LPOLESTR pszHelpTopic
);
Parámetros
[in] pszHelpTopic
Puntero a una cadena terminada en NULL que especifica el tema que se va a mostrar en el archivo de ayuda HTML de MMC combinado. La cadena debe tener el formato siguiente:
helpfilename::topicfilename
donde helpfilename es el nombre de archivo del archivo de ayuda HTML del complemento (.chm) que MMC combinó en el archivo de colección de ayuda HTML de MMC (este es el nombre de archivo, no la ruta de acceso al archivo de ayuda HTML original) y topicfilename es la ruta de acceso interna al archivo de tema dentro del archivo .chm del complemento. El autor del archivo de ayuda HTML del complemento determina si hay una estructura de directorio interna para los archivos HTML del tema o si todos los archivos HTML del tema están en la raíz del archivo .chm.
Un complemento indica a MMC sobre su archivo .chm en su implementación del método ISnapinHelp2::GetHelpTopic .
Por ejemplo, si el complemento tenía el archivo de ayuda HTML mysnapin.chm combinado en el archivo de colección de ayuda HTML mmC y un archivo HTML de tema que tenía la ruta de acceso interna del archivo htm/help01.htm, la cadena tendría el siguiente formato:
mysnapin.chm::htm/help01.htm
Si, en su lugar, el archivo de tema de help01.htm está en la raíz del archivo de ayuda mysnapin.chm, la cadena debe tener el siguiente formato:
mysnapin.chm::/help01.htm
La compatibilidad con identificadores numéricos para temas no se incluye en las versiones 1.2 y anteriores.
Valor devuelto
Este método puede devolver uno de estos valores.
Comentarios
Las versiones 1.0 y 1.1 de MMC requerían que pszHelpTopic se asignara con la función de API COM CoTaskMemAlloc y que MMC liberaría la cadena. Esto infringía las reglas COM para la asignación de parámetros en, lo que requiere que el autor de la llamada asigne y libere ambos. En MMC 1.2 y MMC 2.0, ya no es necesario asignar pszHelpTopic con CoTaskMemAlloc. El autor de la llamada es libre de usar cualquier administración de memoria que desee. Si el autor de la llamada elige usar CoTaskMemAlloc, también es responsable de llamar a CoTaskMemFree para liberar la cadena.
Un complemento puede proporcionar ayuda contextual para el elemento seleccionado controlando la notificación de MMCN_CONTEXTHELP en su método IComponent::Notify y llamando a IDisplayHelp::ShowTopic.
Para las páginas de propiedades, el complemento debe llamar a MMCPropertyHelp en lugar de IDisplayHelp::ShowTopic. Dado que una hoja de propiedades de MMC se ejecuta normalmente en un subproceso independiente, la página de propiedades no puede usar directamente la interfaz IDisplayHelp . En su lugar, la página de propiedades puede llamar a MMCPropertyHelp desde la biblioteca MMC para lograr el mismo resultado. MMCPropertyHelp toma el mismo parámetro de cadena de tema que IDisplayHelp::ShowTopic y controla la serialización de la solicitud al subproceso MMC principal.
Si el complemento controla la notificación de MMCN_CONTEXTHELP , MMC espera que el complemento especifique un tema de Ayuda para el elemento seleccionado. Por lo tanto, en el controlador de notificaciones para la notificación de MMCN_CONTEXTHELP , el complemento tiene dos opciones:
- Puede llamar a IDisplayHelp::ShowTopic o MMCPropertyHelp para especificar el tema de Ayuda y, a continuación, devolver S_OK para indicar que se ha realizado correctamente. Tenga en cuenta que el complemento solo debe devolver S_OK si especifica un tema de Ayuda. Si el complemento devuelve S_OK sin especificar un tema de Ayuda, no se mostrará ningún tema de Ayuda.
- Puede devolver S_FALSE a la notificación. A continuación, MMC muestra el archivo de colección de Ayuda con el tema MMC predeterminado seleccionado.
Requisitos
| Cliente mínimo compatible | Windows Vista |
| Servidor mínimo compatible | Windows Server 2008 |
| Plataforma de destino | Windows |
| Encabezado | mmc.h |
| Archivo DLL | Mmcndmgr.dll |