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

Recupera la cadena de documentación, el nombre y la ruta de acceso completos del archivo de Ayuda y el identificador de contexto del tema de Ayuda de una descripción de tipos especificada.

Sintaxis

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

Parámetros

[in] memid

Identificador del miembro cuya documentación se va a devolver.

[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

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

[out] pBstrHelpFile

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.
E_OUTOFMEMORY	Memoria insuficiente para completar la operación.

Comentarios

La función GetDocumentation proporciona acceso a la documentación del miembro especificado por el parámetro memid . Si se MEMBERID_NIL el memid pasado, se devuelve la documentación de la descripción del tipo.

Si la descripción del tipo hereda de otra descripción de tipo, esta función es recursiva a la descripción del tipo base, si es necesario, para buscar el elemento con el identificador de miembro solicitado.

El llamador debe usar SysFreeString para liberar los BSTR a los que hace referencia pBstrName, pBstrDocString y pBstrHelpFile.

Requisitos

Requisito	Value
Plataforma de destino	Windows
Encabezado	oaidl.h

Consulte también

Itypeinfo