Compartilhar via

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

  • Artigo

Recupera a cadeia de caracteres de documentação, o nome e o caminho completos do arquivo de Ajuda e a ID de contexto do tópico da Ajuda de uma descrição de tipo especificada.

Sintaxe

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

Parâmetros

[in] memid

A ID do membro cuja documentação 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 contexto de localização da Ajuda. Se o chamador não precisar do contexto de Ajuda, ele poderá ser nulo.

[out] pBstrHelpFile

O nome totalmente qualificado do arquivo que contém a DLL usada para o arquivo de Ajuda. Se o chamador não precisar do nome do arquivo, ele 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 dos argumentos não são válidos.
E_OUTOFMEMORY
Memória insuficiente para concluir a operação.

Comentários

A função GetDocumentation fornece acesso à documentação do membro especificado pelo parâmetro memid . Se o memid passado for MEMBERID_NIL, a documentação da descrição do tipo será retornada.

Se a descrição do tipo herdar de outra descrição de tipo, essa função será recursiva para a descrição do tipo base, se necessário, para localizar o item com a ID de membro solicitada.

O chamador deve usar SysFreeString para liberar os BSTRs referenciados por pBstrName, pBstrDocString e pBstrHelpFile.

Requisitos

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

Confira também

ITypeInfo