Funzione HtmlHelpA (htmlhelp.h)

Articolo
11/20/2024

Visualizza una finestra della Guida.

Usando i comandi API, è possibile specificare l'argomento da visualizzare nella finestra della Guida, indipendentemente dal fatto che la finestra della Guida sia un Visualizzatore della Guida a tre riquadri o una finestra popup e se è necessario accedere al file dell'argomento HTML tramite un ID contesto, un URL della Guida HTML o una ricerca KLink (Keyword link).

Sintassi

HWND HtmlHelpA(
  [in, optional] HWND      hwndCaller,
  [in]           LPCSTR    pszFile,
  [in]           UINT      uCommand,
  [in]           DWORD_PTR dwData
);

Parametri

[in, optional] hwndCaller

Specifica l'handle (hwnd) della finestra che chiama HtmlHelp. La finestra della Guida è di proprietà di questa finestra.

Quando la finestra della Guida viene chiusa, HtmlHelp restituirà lo stato attivo al proprietario, a meno che il proprietario non sia il desktop. Se hwndCaller è il desktop, il sistema operativo determina dove viene restituito lo stato attivo.

Inoltre, se HtmlHelp invia messaggi di notifica dalla finestra della Guida, vengono inviati a hwndCaller purché sia stato abilitato messaggio di notifica rilevamento nella definizione della finestra della Guida.

[in] pszFile

A seconda del valore uCommand, specifica il percorso del file in un file della Guida compilata (con estensione chm) o in un file di argomento all'interno di un file della Guida specificato.

È inoltre possibile specificare un tipo di finestra nome, preceduto da un carattere maggiore di (>).

Se il comando specificato non richiede un file, questo valore può essere NULL.

[in] uCommand

Specifica il comando da completare.

[in] dwData

Specifica tutti i dati che possono essere necessari, in base al valore del parametro uCommand.

Valore restituito

A seconda del specificato uCommand e del risultato, HtmlHelp restituisce uno o entrambi gli elementi seguenti:

Handle (hwnd) della finestra della Guida.
NULL. In alcuni casi, NULL indica un errore; in altri casi, NULL indica che la finestra della Guida non è ancora stata creata.

Osservazioni

La sintassi si applica ai set di caratteri ANSI. Quando si usa un set di caratteri Unicode, il tipo del parametro pszFile deve essere "LPCTSTR".

Quando si usa l'API della Guida HTML, impostare le dimensioni dello stack dell'eseguibile dell'hosting su almeno 100.000. Se le dimensioni dello stack definite sono troppo piccole, il thread creato per eseguire la Guida HTML verrà creato anche con questa dimensione dello stack e l'errore potrebbe risultare. Facoltativamente, è possibile rimuovere /STACK dalla riga di comando del collegamento e rimuovere qualsiasi impostazione STACK nel file DEF dell'eseguibile (in questo caso le dimensioni dello stack predefinite sono 1 MB). È anche possibile impostare le dimensioni dello stack usando il comando del compilatore /Fnumber . Il compilatore lo passerà al linker come /STACK.

Esempi

Nell'esempio seguente viene chiamato il comando HH_DISPLAY_TOPIC per aprire il file della Guida denominato Help.chm e visualizzarne l'argomento predefinito nella finestra della Guida denominata Mainwin. In genere, la finestra della Guida specificata in questo comando è standard visualizzatore della Guida HTML.

HWND hwnd =
   HtmlHelp(
            GetDesktopWindow(),
            "c:\\Help.chm::/Intro.htm>Mainwin",
            HH_DISPLAY_TOPIC,
            NULL) ;

Nota

L'intestazione htmlhelp.h definisce HtmlHelp come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante del preprocessore UNICODE. La combinazione dell'utilizzo dell'alias indipendente dalla codifica con il codice non indipendente dalla codifica può causare mancate corrispondenze che generano errori di compilazione o di runtime. Per altre informazioni, vedere convenzioni di per i prototipi di funzioni.

Fabbisogno

Requisito	Valore
piattaforma di destinazione	Finestre
intestazione	htmlhelp.h
libreria	Htmlhelp.lib
dll	hhctrl.ocx

Vedere anche

Informazioni sull'API della Guida HTML

Condividi tramite