Metodo ITypeInfo::GetDocumentation (oaidl.h)

Articolo
02/29/2024

Recupera la stringa di documentazione, il nome e il percorso completo del file della Guida e l'ID del contesto per l'argomento della Guida relativo a una descrizione del tipo specifica.

Sintassi

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

Parametri

[in] memid

ID del membro di cui restituire la documentazione.

[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

Contesto di localizzazione della Guida. Se il chiamante non necessita del contesto della Guida, può essere Null.

[out] pBstrHelpFile

Nome completo del file contenente la DLL usata per il file della Guida. Se il chiamante non necessita del nome 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.
E_OUTOFMEMORY	Memoria insufficiente per completare l'operazione.

Commenti

La funzione GetDocumentation fornisce l'accesso alla documentazione per il membro specificato dal parametro memid . Se il memid passato è MEMBERID_NIL, viene restituita la documentazione per la descrizione del tipo.

Se la descrizione del tipo eredita da un'altra descrizione del tipo, questa funzione viene ricorsiva alla descrizione del tipo di base, se necessario, per trovare l'elemento con l'ID membro richiesto.

Il chiamante deve usare SysFreeString per liberare le richieste BSTR a cui fa riferimento pBstrName, pBstrDocString e pBstrHelpFile.

Requisiti

Requisito	Valore
Piattaforma di destinazione	Windows
Intestazione	oaidl.h

Vedi anche

Itypeinfo

Condividi tramite