Метод ISnapinHelp::GetHelpTopic (mmc.h)
Позволяет оснастке добавить скомпилированный HTML-файл справки в файл коллекции справки MMC.
Синтаксис
HRESULT GetHelpTopic(
[out] LPOLESTR *lpCompiledHelpFile
);
Параметры
[out] lpCompiledHelpFile
Указатель на адрес строки Юникода, заканчивающейся null, которая содержит путь к скомпилированному файлу справки (CHM) для оснастки. При указании пути поместите файл в любое место и укажите полное имя пути.
Возвращаемое значение
Этот метод может возвращать одно из этих значений.
Комментарии
MMC вызывает реализацию этого метода оснастки, чтобы получить расположение файла справки оснастки. MMC объединяет html-файлы справки всех оснастки с файлом коллекции HTML-справки консоли MMC.
Иерархия тем из файла справки оснастки будет отображаться в оглавлении при просмотре коллекции.
Объединяя html-файлы справки, MMC создает единую интегрированную функцию оглавления, индекса и поиска справки HTML. Когда пользователь нажимает кнопку Справка в консоли управления (Майкрософт) в меню main справка, MMC открывает объединенный файл справки, содержащий HTML-файлы справки для всех оснасток в текущем файле консоли.
Выделите строку lpCompiledHelpFile с помощью функции COM API CoTaskMemAlloc (или эквивалента), и MMC выпустит ее.
Примеры
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;
}
Требования
| Минимальная версия клиента | Windows Vista |
| Минимальная версия сервера | Windows Server 2008 |
| Целевая платформа | Windows |
| Header | mmc.h |