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

Статья
08/25/2023

Метод IAccessible::get_accHelp извлекает строку свойства Help объекта . Не все объекты поддерживают это свойство.

Синтаксис

HRESULT get_accHelp(
  [in]          VARIANT varChild,
  [out, retval] BSTR    *pszHelp
);

Параметры

[in] varChild

Тип: VARIANT

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

[out, retval] pszHelp

Тип: BSTR*

Адрес BSTR , который получает локализованную строку, содержащую справочные сведения для указанного объекта, или значение NULL , если справочные сведения недоступны.

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

Тип: HRESULT

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

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

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

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

Пример сервера

В следующем примере кода показана одна из возможных реализаций этого метода для настраиваемого списка. В зависимости от состояния контакта в списке отображается другой текст. Для простоты в примере не выполняется локализация возвращаемой строки.


// m_pControl is the custom control that returns this accessible object. 
// 'online' is an enumerated value. 

HRESULT STDMETHODCALLTYPE AccServer::get_accHelp( 
    VARIANT varChild,
    BSTR *pszHelp)
{
    *pszHelp = NULL;
    if (varChild.vt != VT_I4)
    {
        return E_INVALIDARG;
    }
    if (varChild.lVal == CHILDID_SELF)
    {
        *pszHelp = SysAllocString(L"Contact list.");
    }
    else
    {
        int index = (int)varChild.lVal - 1;
        CustomListControlItem* pItem = m_pControl->GetItemAt(index);
        if (pItem == NULL)
        {
            return E_INVALIDARG;
        }
        if (pItem->GetStatus() == online)
        {
            *pszHelp = SysAllocString(L"Online contact.");
        }
        else 
        {
            *pszHelp = SysAllocString(L"Offline contact.");
        }
    }
    return S_OK;
};

Требования

Требование	Значение
Минимальная версия клиента	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