Функция MMCPropertyHelp (mmc.h)
Функция MMCPropertyHelp появилась в MMC 1.1.
Функция MMCPropertyHelp отображает указанный раздел справки HTML в объединенном HTML-файле справки MMC для страницы свойств.
Синтаксис
HRESULT MMCPropertyHelp(
LPOLESTR pszHelpTopic
);
Параметры
pszHelpTopic
Указатель на строку, завершающуюся значением NULL, задающую раздел, отображаемый в объединенном HTML-файле справки MMC. Строка должна иметь следующий формат:
helpfilename::topicfilename
где helpfilename — имя файла html-файла справки оснастки (CHM), который MMC объединяет в HTML-файл справки MMC (только имя файла, а не путь к исходному ФАЙЛу справки HTML), а topicfilename — внутренний путь к файлу раздела в CHM-файле оснастки. Автор HTML-файла справки оснастки определяет, имеется ли внутренняя структура каталогов для HTML-файлов раздела или все HTML-файлы раздела находятся в корне CHM-файла.
Например, если в оснастке файл справки HTML mysnapin.chm был объединен с HTML-файлом справки MMC и HTML-файлом раздела с внутренним путем к файлу справки htm/snphlp01.htm, строка будет иметь следующую форму:
mysnapin.chm::htm/snphlp01.htm
Поддержка числовых идентификаторов для разделов недоступна в этом выпуске.
Возвращаемое значение
Эта функция обратного вызова может возвращать одно из этих значений.
Комментарии
Вызовите MMCPropertyHelp в обработчике уведомлений для уведомления MMCN_CONTEXTHELP .
Оснастка может предоставлять контекстную справку на странице свойств. Так как страница свойств MMC обычно выполняется в отдельном потоке, страница свойств не может напрямую использовать интерфейс IDisplayHelp . Вместо этого страница свойств может вызывать MMCPropertyHelp из библиотеки MMC для достижения того же результата. MMCPropertyHelp принимает тот же параметр строки раздела, что и IDisplayHelp::ShowTopic, и обрабатывает маршалинг запроса к main потоку MMC.
Если оснастка обрабатывает уведомление MMCN_CONTEXTHELP , MMC ожидает, что оснастка укажет раздел справки для выбранного элемента. Следовательно, в обработчике уведомлений для уведомления MMCN_CONTEXTHELP оснастка имеет два варианта:
- Он может вызвать IDisplayHelp::ShowTopic или MMCPropertyHelp , чтобы указать раздел справки, а затем вернуть S_OK для указания успеха. Имейте в виду, что оснастка должна возвращать S_OK , только если в ней указан раздел справки. Если оснастка возвращает S_OK без указания раздела справки, раздел справки не отображается.
- Он может возвращать S_FALSE в уведомление. Затем MMC выводит оглавление с выбранным разделом MMC по умолчанию.
Требования
| Минимальная версия клиента | Windows Vista |
| Минимальная версия сервера | Windows Server 2008 |
| Целевая платформа | Windows |
| Header | mmc.h |