Método ITypeLib::GetDocumentation (oaidl.h)

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

Sintaxis

HRESULT GetDocumentation(
  [in]  INT   index,
  [out] BSTR  *pBstrName,
  [out] BSTR  *pBstrDocString,
  [out] DWORD *pdwHelpContext,
  [out] BSTR  *pBstrHelpFile
);

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 propia biblioteca.

[out] pBstrName

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

[out] pBstrDocString

Cadena de documentación del elemento especificado. Si el autor de la llamada no necesita la cadena de documentación, pBstrDocString puede ser null..

[out] pdwHelpContext

Identificador de contexto de ayuda (ID) asociado al elemento especificado. Si el autor de la llamada no necesita el identificador de contexto de ayuda, pdwHelpContext puede ser null.

[out] pBstrHelpFile

Nombre completo del archivo de Ayuda. Si el autor de la llamada no necesita el nombre del archivo de Ayuda, pBstrHelpFile 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

El llamador debe liberar los parámetros pBstrName, pBstrDocString y pBstrHelpFile.

Requisitos

Requisito	Value
Plataforma de destino	Windows
Encabezado	oaidl.h

Consulte también

ITypeLib