Поделиться через


Метод IPropertyPage::Help (ocidl.h)

Вызывает справку страницы свойств в ответ на запрос пользователя.

Синтаксис

HRESULT Help(
  [in] LPCOLESTR pszHelpDir
);

Параметры

[in] pszHelpDir

Указатель на строку в разделе HelpDir в сведениях CLSID страницы свойств в реестре. Если HelpDir не существует, это будет путь, найденный в записи InprocServer32 , за вычетом имени файла сервера. (Обратите внимание, что localServer32 не установлен, так как локальные страницы свойств не поддерживаются.

Возвращаемое значение

Этот метод может возвращать стандартные возвращаемые значения E_OUTOFMEMORY и E_UNEXPECTED, а также следующие значения.

Код возврата Описание
S_OK
На странице отображается собственная справка.
E_NOTIMPL
Справка либо не предоставляется, либо предоставляется только с помощью информации PROPPAGEINFO.

Комментарии

Примечания к вызывающим абонентам

Вызовы этого метода должны происходить между вызовами IPropertyPage::Activate и IPropertyPage::D eactivate.

Примечания для разработчиков

Если страница не выполняет этот метод (например, E_NOTIMPL), фрейм попытается использовать элементы pszHelpFile и dwHelpContext структуры PROPPAGEINFO , полученные через IPropertyPage::GetPageInfo. Поэтому страница должна либо реализовывать IPropertyPage::Help , либо возвращать справочные сведения через IPropertyPage::GetPageInfo.

Требования

Требование Значение
Минимальная версия клиента Windows 2000 Professional [только классические приложения]
Минимальная версия сервера Windows 2000 Server [только классические приложения]
Целевая платформа Windows
Header ocidl.h

См. также раздел

IPropertyPage

PROPPAGEINFO