Funzione MLHtmlHelp

[Questa funzione è disponibile tramite Windows XP e Windows Server 2003. Potrebbe essere modificato o non disponibile nelle versioni successive di Windows.]

Visualizza una finestra della Guida corrispondente all'impostazione corrente della lingua dell'interfaccia utente.

Sintassi

HWND MLHtmlHelp(
  _In_ HWND      hwndCaller,
  _In_ LPCTSTR   pszFile,
  _In_ UINT      uCommand,
  _In_ DWORD_PTR dwData,
  _In_ DWORD     dwCrossCodePage
);

Parametri

hwndCaller [in]

Tipo: HWND

Handle per la finestra padre che chiama questa funzione.

pszFile [in]

Tipo: LPCTSTR

Puntatore a un buffer contenente il percorso completo di un file della Guida compilata (con estensione chm) o un file di argomenti all'interno di un file della Guida specificato.

uCommand [in]

Tipo: UINT

Comando da completare. Questa funzione supporta direttamente solo HH_DISPLAY_TOPIC e HH_DISPLAY_TEXT_POPUP. Nel caso di qualsiasi altro comando, la chiamata viene inoltrata senza il valore dwCrossCodePage a HtmlHelp.

dwData [in]

Tipo: DWORD_PTR

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

dwCrossCodePage [in]

Tipo: DWORD

Valore DWORD che indica la tabella codici dell'impostazione corrente della lingua dell'interfaccia utente, ad esempio CP_ACP.

Valore restituito

Tipo: HWND

A seconda dell'oggetto uCommand e del risultato specificato, MLHtmlHelp 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.

Commenti

Se si verifica un problema con il percorso del file della Guida per la lingua corrente, la chiamata viene inoltrata a HtmlHelp per la gestione standard.

Quando la finestra della Guida viene chiusa, lo stato attivo torna 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 MLHtmlHelp invia messaggi di notifica dalla finestra della Guida, i messaggi vengono inviati a hwndCaller purché sia stato abilitato il rilevamento dei messaggi di notifica nella definizione della finestra della Guida.

Esempio

Nell'esempio seguente viene chiamato il comando HH_DISPLAY_TOPIC per aprire il file della Guida denominato Help.chm e visualizzare il relativo 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,
                     CP_ACP);

Nota

Quando si usa questa funzione, impostare le dimensioni dello stack dell'eseguibile di 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'operazione potrebbe non riuscire. Facoltativamente, è possibile rimuovere /STACK dalla riga di comando del collegamento e rimuovere anche 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 passerà questo valore al linker come /STACK).

 

Requisiti

Requisito Valore
Client minimo supportato
Windows 2000 Professional, Windows XP [solo app desktop]
Server minimo supportato
Windows Server 2003 [solo app desktop]
Intestazione
Nessuno
DLL
Shlwapi.dll (versione 5.0 o successiva)
Nomi Unicode e ANSI
MLHtmlHelpW (Unicode) e MLHtmlHelpA (ANSI)