Função MMCPropertyHelp (mmc.h)
A função MMCPropertyHelp é introduzida no MMC 1.1.
A função MMCPropertyHelp exibe o tópico de Ajuda HTML especificado no arquivo de Ajuda HTML do MMC mesclado para uma página de propriedades.
Sintaxe
HRESULT MMCPropertyHelp(
LPOLESTR pszHelpTopic
);
Parâmetros
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 Ajuda HTML do MMC (somente 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.
Por exemplo, se o snap-in tiver o arquivo de Ajuda HTML mysnapin.chm mesclado ao arquivo de Ajuda HTML do MMC e um arquivo HTML de tópico que tinha o caminho interno do arquivo de Ajuda de htm/snphlp01.htm, a cadeia de caracteres teria o seguinte formulário:
mysnapin.chm::htm/snphlp01.htm
O suporte para IDs numéricas para tópicos não está disponível nesta versão.
Valor retornado
Essa função de retorno de chamada pode retornar um desses valores.
Comentários
Chame MMCPropertyHelp no manipulador de notificação para a notificação de MMCN_CONTEXTHELP .
Um snap-in pode fornecer ajuda de contexto em uma página de propriedades. 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 apresenta o sumário 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 |