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

El método IAccessible::get_accHelpTopic recupera la ruta de acceso completa del archivo WinHelp asociado al objeto especificado; también recupera el identificador del tema adecuado dentro de ese archivo. No todos los objetos admiten esta propiedad. Esta propiedad rara vez se admite o usa en las aplicaciones.

NotaIAccessible::get_accHelpTopic está en desuso y no se debe usar.

 

Sintaxis

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

Parámetros

[out] pszHelpFile

Tipo: BSTR*

Dirección de un BSTR que recibe la ruta de acceso completa del archivo WinHelp asociado al objeto especificado.

[in] varChild

Tipo: VARIANT

Especifica si el tema de Ayuda recuperado pertenece al objeto o a uno de los elementos secundarios del objeto. Este parámetro es CHILDID_SELF (para obtener un tema de Ayuda para el objeto) o un identificador secundario (para obtener un tema de Ayuda para 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.

pidTopic

Tipo: long*

[out, retval] Dirección de una variable que identifica el tema del archivo de Ayuda asociado al objeto especificado. Este valor se usa como identificador de contexto del tema deseado que pasa a la función WinHelp . Al llamar a WinHelp para mostrar el tema, establezca el parámetro uCommand en HELP_CONTEXT, convierta el valor al que apunta pidTopic en un DWORD y páselo como parámetro dwData .

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 Comprobar 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

La obtención de información de un archivo de Ayuda puede ser un uso intensivo de la memoria y el tiempo.

Nota para los desarrolladores de servidores: Esta propiedad proporciona acceso a un tema de Ayuda en WinHelp, mientras que IAccessible::get_accHelp devuelve una cadena. Los objetos no son necesarios para admitir IAccessible::get_accHelp e IAccessible::get_accHelpTopic, pero deben admitir al menos uno. Si pueden devolver 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.

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

Consulte también

HelpTopic (propiedad)

IAccessible

IAccessible::get_accHelp