Metodo ITypeLib::GetDocumentation (oaidl.h)

  • Articolo

Recupera la stringa di documentazione per la libreria, il nome e il percorso completi del file della Guida e l'identificatore di contesto per l'argomento della Guida della libreria nel file della Guida.

Sintassi

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

Parametri

[in] index

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

[out] pBstrName

Nome dell'elemento specificato. Se il chiamante non necessita del nome dell'elemento, pBstrName può essere null.

[out] pBstrDocString

Stringa di documentazione per l'elemento specificato. Se il chiamante non necessita della stringa di documentazione, pBstrDocString può essere null.

[out] pdwHelpContext

Identificatore del contesto della Guida (ID) associato all'elemento specificato. Se il chiamante non necessita dell'ID contesto della Guida, pdwHelpContext può essere null.

[out] pBstrHelpFile

Nome completo del file della Guida. Se il chiamante non necessita del nome del file della Guida, pBstrHelpFile 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

Il chiamante deve liberare i parametri pBstrName, pBstrDocString e pBstrHelpFile.

Requisiti

Requisito Valore
Piattaforma di destinazione Windows
Intestazione oaidl.h

Vedi anche

Itypelib