Compartilhar via

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

  • Artigo

Recupera a cadeia de caracteres de documentação da biblioteca, o nome e o caminho completos do arquivo de Ajuda e o identificador de contexto do tópico ajuda da biblioteca no arquivo de Ajuda.

Sintaxe

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

Parâmetros

[in] index

O índice da descrição de tipo cuja documentação deve ser retornada. Se index for -1, a documentação da própria biblioteca será retornada.

[out] pBstrName

O nome do item especificado. Se o chamador não precisar do nome do item, pBstrName poderá ser nulo.

[out] pBstrDocString

A cadeia de caracteres de documentação do item especificado. Se o chamador não precisar da cadeia de caracteres de documentação, pBstrDocString poderá ser nulo..

[out] pdwHelpContext

O ID (identificador de contexto) da Ajuda associado ao item especificado. Se o chamador não precisar da ID de contexto da Ajuda, pdwHelpContext poderá ser nulo.

[out] pBstrHelpFile

O nome totalmente qualificado do arquivo de Ajuda. Se o chamador não precisar do nome do arquivo de Ajuda, pBstrHelpFile poderá ser nulo.

Retornar valor

Esse método pode retornar um desses valores.

Código de retorno Descrição
S_OK
Êxito.
E_INVALIDARG
Um ou mais argumentos não são válidos.
STG_E_INSUFFICIENTMEMORY
Memória insuficiente para concluir a operação.

Comentários

O chamador deve liberar os parâmetros pBstrName, pBstrDocString e pBstrHelpFile.

Requisitos

Requisito Valor
Plataforma de Destino Windows
Cabeçalho oaidl.h

Confira também

Itypelib