Metodo ITypeLib2::GetDocumentation2 (oaidl.h)

Recupera la stringa di documentazione della libreria, il percorso e il nome completo del file della Guida, il contesto di localizzazione da usare e l'ID del contesto per l'argomento della Guida della libreria nel file della Guida.

Sintassi

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

Parametri

[in] index

Indice della descrizione del tipo di cui restituire la documentazione. Se l'indice è -1, viene restituita la documentazione per la libreria.

[in] lcid

Identificatore delle impostazioni locali.

[out] pbstrHelpString

Nome dell'elemento specificato. Se il chiamante non ha bisogno del nome dell'elemento, pbstrHelpString può essere null

[out] pdwHelpStringContext

Contesto di localizzazione della Guida. Se il chiamante non ha bisogno del contesto della Guida, può essere null.

[out] pbstrHelpStringDll

Nome completo del file contenente la DLL utilizzata per il file della Guida. Se il chiamante non ha bisogno del nome del file, può essere Null.

Valore restituito

Questo metodo può restituire uno di questi valori.

Codice restituito	Descrizione
S_OK	Operazione completata.
E_INVALIDARG	Uno o più argomenti non sono validi.
STG_E_INSUFFICIENTMEMORY	Memoria insufficiente per completare l'operazione.

Commenti

Ottiene informazioni a livello di libreria dei tipi. Il chiamante deve liberare i parametri BSTR.

Questa funzione chiamerà _DLLGetDocumentation nella DLL specificata per recuperare la stringa della Guida desiderata, se è presente un contesto della stringa della Guida per questo elemento. Se non esiste alcun contesto della stringa della Guida o si verifica un errore, verrà posticipato al metodo GetDocumentation e restituirà la stringa di documentazione associata.

Requisiti

Requisito	Valore
Piattaforma di destinazione	Windows
Intestazione	oaidl.h

Vedi anche

ITypeLib2