Compartilhar via

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

  • Artigo

Recupera a cadeia de caracteres de documentação da biblioteca, o nome e o caminho completos do arquivo de Ajuda, o contexto de localização a ser usado e a ID de contexto para o tópico da Ajuda da biblioteca no arquivo de Ajuda.

Sintaxe

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

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 biblioteca será retornada.

[in] lcid

O identificador de localidade.

[out] pbstrHelpString

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

[out] pdwHelpStringContext

O contexto de localização da Ajuda. Se o chamador não precisar do contexto de Ajuda, ele poderá ser nulo.

[out] pbstrHelpStringDll

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 argumentos não são válidos.
STG_E_INSUFFICIENTMEMORY
Memória insuficiente para concluir a operação.

Comentários

Obtém informações no nível da biblioteca de tipos. O chamador deve liberar os parâmetros BSTR.

Essa função chamará _DLLGetDocumentation na DLL especificada para recuperar a cadeia de caracteres de Ajuda desejada, se houver um contexto de cadeia de caracteres de Ajuda para este item. Se nenhum contexto de cadeia de caracteres de Ajuda existir ou ocorrer um erro, ele adiará para o método GetDocumentation e retornará a cadeia de caracteres de documentação associada.

Requisitos

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

Confira também

Itypelib2