Compartir a través de

Método ITypeLib2::GetDocumentation2 (oaidl.h)

  • Artículo

Recupera la cadena de documentación de la biblioteca, el nombre completo del archivo de ayuda y la ruta de acceso, el contexto de localización que se utiliza y el identificador de contexto para el tema de Ayuda de la biblioteca en el archivo de ayuda.

Sintaxis

HRESULT GetDocumentation2(
  [in]  INT   index,
  [in]  LCID  lcid,
  [out] BSTR  *pbstrHelpString,
  [out] DWORD *pdwHelpStringContext,
  [out] BSTR  *pbstrHelpStringDll
);

Parámetros

[in] index

Índice de la descripción de tipo cuya documentación se va a devolver. Si el índice es -1, se devuelve la documentación de la biblioteca.

[in] lcid

El identificador de configuración regional.

[out] pbstrHelpString

Nombre del elemento especificado. Si el autor de la llamada no necesita el nombre del elemento, pbstrHelpString puede ser null.

[out] pdwHelpStringContext

Contexto de localización de ayuda. Si el autor de la llamada no necesita el contexto de ayuda, puede ser NULL.

[out] pbstrHelpStringDll

Nombre completo del archivo que contiene el archivo DLL usado para el archivo de ayuda. Si el autor de la llamada no necesita el nombre de archivo, puede ser NULL.

Valor devuelto

Este método puede devolver uno de estos valores.

Código devuelto Descripción
S_OK
Correcto.
E_INVALIDARG
Uno o varios de los argumentos no son válidos.
STG_E_INSUFFICIENTMEMORY
Memoria insuficiente para completar la operación.

Comentarios

Obtiene información en el nivel de biblioteca de tipos. El autor de la llamada debe liberar los parámetros BSTR.

Esta función llamará a _DLLGetDocumentation en el archivo DLL especificado para recuperar la cadena de Ayuda deseada, si hay un contexto de cadena de ayuda para este elemento. Si no existe ningún contexto de cadena de ayuda o se produce un error, se aplazará al método GetDocumentation y devolverá la cadena de documentación asociada.

Requisitos

Requisito Value
Plataforma de destino Windows
Encabezado oaidl.h

Consulte también

ITypeLib2