Funzione HtmlHelpW (htmlhelp.h)

Visualizza una finestra della Guida.

Usando i comandi api, è possibile specificare quale argomento visualizzare nella finestra della Guida, se la finestra della Guida è un Visualizzatore guida a tre riquadri o una finestra popup e se il file di argomento HTML deve essere accessibile tramite un ID contesto, un URL della Guida HTML o un collegamento A parole chiave (KLink).

Sintassi

HWND HtmlHelpW(
  [in, optional] HWND      hwndCaller,
  [in]           LPCWSTR   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 eventuali messaggi di notifica dalla finestra della Guida, vengono inviati a hwndCaller purché sia stato abilitato il rilevamento dei messaggi di notifica nella definizione della finestra della Guida.

[in] pszFile

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

È anche possibile specificare un nome del tipo di finestra , 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 dell'oggetto uCommand specificato e del risultato, HtmlHelp restituisce una o entrambe le opzioni seguenti:

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

Commenti

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 Guida HTML, impostare le dimensioni dello stack dell'eseguibile di hosting su almeno 100k. 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 potrebbe verificarsi un errore. Facoltativamente, è possibile rimuovere /STACK dalla riga di comando del collegamento e rimuovere qualsiasi impostazione STACK nel file DEF del file eseguibile (le dimensioni predefinite dello stack sono 1 MB in questo caso). È anche possibile impostare le dimensioni dello stack usando il comando /Fnumber del compilatore (il compilatore passerà questo al linker come /STACK).

Esempio

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 è un Visualizzatore guida HTML standard.

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 di codifica neutrale con il codice che non è neutrale dalla codifica può causare errori di corrispondenza che causano errori di compilazione o runtime. Per altre informazioni, vedere Convenzioni per i prototipi di funzione.

Requisiti

Requisito	Valore
Piattaforma di destinazione	Windows
Intestazione	htmlhelp.h
Libreria	Htmlhelp.lib
DLL	hhctrl.ocx

Vedi anche

Informazioni sull'API Guida HTML