Método IAccessible::get_accHelp (oleacc.h)

Artículo
02/29/2024

El método IAccessible::get_accHelp recupera la cadena de propiedad Help de un objeto . No todos los objetos admiten esta propiedad.

Sintaxis

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

Parámetros

[in] varChild

Tipo: VARIANT

Especifica si la información de ayuda recuperada pertenece al objeto o a uno de los elementos secundarios del objeto. Este parámetro es CHILDID_SELF (para obtener información sobre el objeto) o un identificador secundario (para obtener información sobre uno de los elementos secundarios del objeto). Para obtener más información sobre cómo inicializar variant, vea Cómo se usan los identificadores secundarios en parámetros.

[out, retval] pszHelp

Tipo: BSTR*

Dirección de un BSTR que recibe la cadena localizada que contiene la información de ayuda para el objeto especificado o NULL si no hay información de ayuda disponible.

Valor devuelto

Tipo: HRESULT

Si se ejecuta correctamente, devuelve S_OK.

Si no se ejecuta correctamente, devuelve uno de los valores de la tabla siguiente u otro código de error COM estándar. Los servidores devuelven estos valores, pero los clientes siempre deben comprobar los parámetros de salida para asegurarse de que contienen valores válidos. Para obtener más información, vea Comprobación de valores devueltos de IAccessible.

Error	Descripción
S_FALSE	No hay información de ayuda disponible.
E_INVALIDARG	Un argumento no es válido.
DISP_E_MEMBERNOTFOUND	El objeto no admite esta propiedad.

Comentarios

Ninguno de los controles predefinidos y comunes admite esta propiedad.

Nota para los desarrolladores de servidores: Localice la cadena devuelta de esta propiedad.

Esta propiedad devuelve una cadena, mientras que IAccessible::get_accHelpTopic proporciona acceso a un tema de Ayuda en WinHelp. Los objetos no son necesarios para admitir IAccessible::get_accHelp e IAccessible::get_accHelpTopic, pero deben admitir al menos uno. Si devuelven fácilmente una cadena, deben admitir IAccessible::get_accHelp ; de lo contrario, deben admitir IAccessible::get_accHelpTopic. Si se admiten ambos, IAccessible::get_accHelpTopic proporciona información más detallada.

Ejemplo de servidor

En el código de ejemplo siguiente se muestra una posible implementación de este método para un cuadro de lista personalizado. Se muestra texto diferente en función del estado del contacto en la lista. Por motivos de simplicidad, el ejemplo no localiza la cadena devuelta.


// 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;
};

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	oleacc.h
Library	Oleacc.lib
Archivo DLL	Oleacc.dll
Redistribuible	RDK de accesibilidad activa 1.3 en Windows NT 4.0 con SP6 y versiones posteriores y Windows 95