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

Artigo
02/29/2024

O método IAccessible::get_accHelp recupera a cadeia de caracteres da propriedade Help de um objeto . Nem todos os objetos dão suporte a essa propriedade.

Sintaxe

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

Parâmetros

[in] varChild

Tipo: VARIANT

Especifica se as informações de ajuda recuperadas pertencem ao objeto ou a um dos elementos filho do objeto. Esse parâmetro é CHILDID_SELF (para obter informações sobre o objeto) ou uma ID filho (para obter informações sobre um dos elementos filho do objeto). Para obter mais informações sobre como inicializar o VARIANT, consulte Como as IDs filho são usadas em parâmetros.

[out, retval] pszHelp

Tipo: BSTR*

Endereço de um BSTR que recebe a cadeia de caracteres localizada que contém as informações de ajuda do objeto especificado ou NULL se nenhuma informação de ajuda estiver disponível.

Retornar valor

Tipo: HRESULT

Se for bem-sucedido, retornará S_OK.

Se não for bem-sucedido, retornará um dos valores na tabela a seguir ou outro código de erro COM padrão. Os servidores retornam esses valores, mas os clientes devem sempre marcar parâmetros de saída para garantir que eles contenham valores válidos. Para obter mais informações, consulte Verificando valores retornados do IAccessible.

Erro	Descrição
S_FALSE	Nenhuma informação de ajuda está disponível.
E_INVALIDARG	Um argumento não é válido.
DISP_E_MEMBERNOTFOUND	O objeto não dá suporte a essa propriedade.

Comentários

Nenhum dos controles predefinidos e comuns dá suporte a essa propriedade.

Observação para desenvolvedores de servidores: Localize a cadeia de caracteres retornada dessa propriedade.

Essa propriedade retorna uma cadeia de caracteres, enquanto IAccessible::get_accHelpTopic fornece acesso a um tópico da Ajuda no WinHelp. Os objetos não são necessários para dar suporte a IAccessible::get_accHelp e IAccessible::get_accHelpTopic, mas devem dar suporte a pelo menos um. Se eles retornarem facilmente uma cadeia de caracteres, eles deverão dar suporte a IAccessible::get_accHelp ; caso contrário, eles devem dar suporte a IAccessible::get_accHelpTopic. Se ambos tiverem suporte, IAccessible::get_accHelpTopic fornecerá informações mais detalhadas.

Exemplo de servidor

O código de exemplo a seguir mostra uma possível implementação desse método para uma caixa de listagem personalizada. Texto diferente é exibido dependendo do status do contato na lista. Para simplificar, o exemplo não localiza a cadeia de caracteres retornada.


// 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	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	oleacc.h
Biblioteca	Oleacc.lib
DLL	Oleacc.dll
Redistribuível	Active Accessibility 1.3 RDK no Windows NT 4.0 com SP6 e posterior e Windows 95