Metodo IAccess::get_accHelpTopic (oleacc.h)

Articolo
02/29/2024

Il metodo IAccess::get_accHelpTopic recupera il percorso completo del file WinHelp associato all'oggetto specificato; recupera anche l'identificatore dell'argomento appropriato all'interno di tale file. Non tutti gli oggetti supportano questa proprietà. Questa proprietà è raramente supportata o usata dalle applicazioni

NotaIAccess::get_accHelpTopic è deprecato e non deve essere usato.

Sintassi

HRESULT get_accHelpTopic(
  [out] BSTR    *pszHelpFile,
  [in]  VARIANT varChild,
        long    *pidTopic
);

Parametri

[out] pszHelpFile

Tipo: BSTR*

Indirizzo di un BSTR che riceve il percorso completo del file WinHelp associato all'oggetto specificato.

[in] varChild

Tipo: VARIANT

Specifica se l'argomento della Guida recuperata appartiene all'oggetto o a uno degli elementi figlio dell'oggetto. Questo parametro è CHILDID_SELF (per ottenere un argomento della Guida per l'oggetto) o un ID figlio (per ottenere un argomento della Guida per uno degli elementi figlio dell'oggetto). Per altre informazioni sull'inizializzazione di VARIANT, vedere Come vengono usati gli ID figlio nei parametri.

pidTopic

Tipo: long*

[out, retval] Indirizzo di una variabile che identifica l'argomento del file della Guida associato all'oggetto specificato. Questo valore viene usato come identificatore di contesto dell'argomento desiderato che passa alla funzione WinHelp . Quando si chiama WinHelp per visualizzare l'argomento, impostare il parametro uCommand su HELP_CONTEXT, eseguire il cast del valore da pidTopic a un DWORD e passarlo come parametro dwData .

Valore restituito

Tipo: HRESULT

Se ha esito positivo, restituisce S_OK.

In caso contrario, restituisce uno dei valori della tabella che segue o un altro codice di errore COM standard. I server restituiscono questi valori, ma i client devono sempre controllare i parametri di output per assicurarsi che contengano valori validi. Per altre informazioni, vedere Controllo dei valori restituiti IAccessibile.

Errore	Descrizione
S_FALSE	Non sono disponibili informazioni sulla Guida.
E_INVALIDARG	Un argomento non è valido.
DISP_E_MEMBERNOTFOUND	L'oggetto non supporta questa proprietà.

Commenti

L'acquisizione di informazioni da un file della Guida potrebbe essere intensivo per il tempo e la memoria.

Nota per gli sviluppatori del server: Questa proprietà fornisce l'accesso a un argomento della Guida in WinHelp, mentre IAccess::get_accHelp restituisce una stringa. Gli oggetti non sono necessari per supportare sia IAccess::get_accHelp che IAccessibile::get_accHelpTopic, ma devono supportare almeno uno. Se possono restituire facilmente una stringa, devono supportare IAccess::get_accHelp; altrimenti devono supportare IAccess::get_accHelpTopic. Se entrambi sono supportati, IAccess::get_accHelpTopic fornisce informazioni più dettagliate.

Requisiti

Requisito	Valore
Client minimo supportato	Windows 2000 Professional [solo app desktop]
Server minimo supportato	Windows Server 2003 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	oleacc.h
Libreria	Oleacc.lib
DLL	Oleacc.dll
Componente ridistribuibile	Accessibilità attiva 1.3 RDK in Windows NT 4.0 con SP6 e versioni successive e Windows 95

Vedi anche

HelpTopic, proprietà

Iaccessible

IAccessibile::get_accHelp

Condividi tramite