Метод IAccessible::get_accHelpTopic (oleacc.h)

Статья
08/25/2023

Метод IAccessible::get_accHelpTopic извлекает полный путь к файлу WinHelp, связанному с указанным объектом; он также получает идентификатор соответствующего раздела в этом файле. Не все объекты поддерживают это свойство. Это свойство редко поддерживается или используется приложениями.

Примечание. IAccessible::get_accHelpTopic не рекомендуется использовать.

Синтаксис

HRESULT get_accHelpTopic(
  [out] BSTR    *pszHelpFile,
  [in]  VARIANT varChild,
        long    *pidTopic
);

Параметры

[out] pszHelpFile

Тип: BSTR*

Адрес BSTR , получающий полный путь к файлу WinHelp, связанному с указанным объектом.

[in] varChild

Тип: VARIANT

Указывает, принадлежит ли полученный раздел справки объекту или одному из дочерних элементов объекта. Этот параметр является либо CHILDID_SELF (для получения раздела справки для объекта), либо идентификатор дочернего элемента (для получения раздела справки для одного из дочерних элементов объекта). Дополнительные сведения об инициализации VARIANT см. в разделе Использование идентификаторов дочерних элементов в параметрах.

pidTopic

Тип: long*

[out, retval] Адрес переменной, определяющей раздел файла справки, связанный с указанным объектом. Это значение используется в качестве идентификатора контекста нужного раздела, который передается в функцию WinHelp . При вызове WinHelp для отображения раздела задайте для параметра uCommand значение HELP_CONTEXT, приведите значение, на которое указывает pidTopic , к DWORD и передайте его в качестве параметра dwData .

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

Тип: HRESULT

Возвращает значение S_OK, если операция завершилась успешно.

В случае успеха возвращает одно из значений в следующей таблице или другой стандартный код ошибки COM. Серверы возвращают эти значения, но клиенты должны всегда проверка выходные параметры, чтобы убедиться, что они содержат допустимые значения. Дополнительные сведения см. в разделе Проверка возвращаемых значений IAccessible.

Ошибка	Описание
S_FALSE	Справочные сведения недоступны.
E_INVALIDARG	Аргумент является недопустимым.
DISP_E_MEMBERNOTFOUND	Объект не поддерживает это свойство.

Обратите внимание на то, что разработчики серверов: Это свойство предоставляет доступ к разделу справки в WinHelp, тогда как IAccessible::get_accHelp возвращает строку. Объекты не обязательно должны поддерживать IAccessible::get_accHelp и IAccessible::get_accHelpTopic, но они должны поддерживать по крайней мере один из них. Если они могут легко возвращать строку, они должны поддерживать IAccessible::get_accHelp; в противном случае они должны поддерживать IAccessible::get_accHelpTopic. Если они поддерживаются, IAccessible::get_accHelpTopic предоставляет более подробные сведения.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows Server 2003 [только классические приложения]
Целевая платформа	Windows
Header	oleacc.h
Библиотека	Oleacc.lib
DLL	Oleacc.dll
Распространяемые компоненты	Активные специальные возможности 1.3 RDK в Windows NT 4.0 с пакетом обновления 6 (SP6) и более поздних версий и Windows 95

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

Свойство HelpTopic

IAccessible

IAccessible::get_accHelp