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

O método IAccessible::get_accHelpTopic recupera o caminho completo do arquivo WinHelp associado ao objeto especificado; ele também recupera o identificador do tópico apropriado dentro desse arquivo. Nem todos os objetos dão suporte a essa propriedade. Essa propriedade raramente tem suporte ou é usada por aplicativos

Observeque IAccessible::get_accHelpTopic foi preterido e não deve ser usado.

 

Sintaxe

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

Parâmetros

[out] pszHelpFile

Tipo: BSTR*

Endereço de um BSTR que recebe o caminho completo do arquivo WinHelp associado ao objeto especificado.

[in] varChild

Tipo: VARIANT

Especifica se o tópico da Ajuda recuperado pertence ao objeto ou a um dos elementos filho do objeto. Esse parâmetro é CHILDID_SELF (para obter um tópico de Ajuda para o objeto) ou uma ID filho (para obter um tópico da Ajuda para 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.

pidTopic

Tipo: long*

[out, retval] Endereço de uma variável que identifica o tópico do arquivo de Ajuda associado ao objeto especificado. Esse valor é usado como o identificador de contexto do tópico desejado que passa para a função WinHelp . Ao chamar WinHelp para exibir o tópico, defina o parâmetro uCommand como HELP_CONTEXT, converta o valor apontado por pidTopic em um DWORD e passe-o como o parâmetro dwData .

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

Obter informações de um arquivo de Ajuda pode fazer uso intensivo de tempo e memória.

Observação para desenvolvedores de servidores: Essa propriedade fornece acesso a um tópico da Ajuda no WinHelp, enquanto IAccessible::get_accHelp retorna uma cadeia de caracteres. 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 puderem retornar 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.

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

Confira também

Propriedade HelpTopic

Iaccessible

IAccessible::get_accHelp