Función MMCPropertyHelp (mmc.h)
La función MMCPropertyHelp se introduce en MMC 1.1.
La función MMCPropertyHelp muestra el tema de ayuda HTML especificado en el archivo de ayuda HTML de MMC combinado para una página de propiedades.
Sintaxis
HRESULT MMCPropertyHelp(
LPOLESTR pszHelpTopic
);
Parámetros
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 ayuda HTML MMC (solo 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.
Por ejemplo, si el complemento tenía el archivo de ayuda HTML mysnapin.chm combinado en el archivo de ayuda HTML MMC y un archivo HTML de tema que tenía la ruta de acceso interna del archivo de ayuda de htm/snphlp01.htm, la cadena tendría el siguiente formato:
mysnapin.chm::htm/snphlp01.htm
La compatibilidad con identificadores numéricos para temas no está disponible en esta versión.
Valor devuelto
Esta función de devolución de llamada puede devolver uno de estos valores.
Comentarios
Llame a MMCPropertyHelp en el controlador de notificaciones para la notificación MMCN_CONTEXTHELP .
Un complemento puede proporcionar ayuda de contexto en una página de propiedades. Dado que una hoja de propiedades de MMC se ejecuta normalmente en un subproceso independiente, la página de propiedades no puede usar la interfaz IDisplayHelp directamente. 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 abre la tabla de contenido con el tema de MMC predeterminado seleccionado.
Requisitos
| Cliente mínimo compatible | Windows Vista |
| Servidor mínimo compatible | Windows Server 2008 |
| Plataforma de destino | Windows |
| Encabezado | mmc.h |