MLWinHelp-Funktion
[Diese Funktion ist über Windows XP und Windows Server 2003 verfügbar. Er kann in nachfolgenden Versionen von Windows geändert oder nicht verfügbar sein.]
Startet Windows Hilfe (Winhelp.exe) und übergibt zusätzliche Daten, die die Art der von der Anwendung angeforderten Hilfe angeben.
Syntax
BOOL MLWinHelp(
_In_ HWND hWndMain,
_In_ LPCTSTR lpszHelp,
_In_ UINT uCommand,
_In_ DWORD_PTR dwData
);
Parameter
-
hWndMain [ In]
-
Typ: HWND
Ein Handle für das Fenster, das Hilfe anfordert. Die MLWinHelp-Funktion verwendet dieses Handle, um nachzuverfolgen, welche Anwendungen Hilfe angefordert haben. Wenn der uCommand-Parameter HELP _ CONTEXTMENU oder HELP WM HELP _ angibt, identifiziert _ hWndMain das Steuerelement, das Hilfe anfordert.
-
lpszHelp [ In]
-
Typ: LPCTSTR
Die Adresse einer auf NULL endenden Zeichenfolge, die ggf. den Pfad enthält, und den Namen der Hilfedatei, die MLWinHelp anzeigen soll.
Auf den Dateinamen kann eine spitze Klammer (>) und der Name eines sekundären Fensters folgen, wenn das Thema in einem sekundären Fenster und nicht im primären Fenster angezeigt werden soll. Sie müssen den Namen des sekundären Fensters im [ ] Windows-Abschnitt der Hilfeprojektdatei (HPJ) definieren.
-
uCommand [ In]
-
Typ: UINT
Der Typ der angeforderten Hilfe. Eine Liste der möglichen Werte und deren Auswirkung auf den Wert, der im dwData-Parameter eingefügt werden soll, finden Sie im Abschnitt Hinweise.
-
dwData [ In]
-
Typ: DWORD _ PTR
Zusätzliche Daten. Der verwendete Wert hängt vom Wert des uCommand-Parameters ab. Eine Liste der möglichen dwData-Werte finden Sie im Abschnitt Hinweise.
Rückgabewert
Typ: BOOL
Gibt bei Erfolg einen Wert ungleich 0 (null) zurück. Andernfalls wird 0 (null) zurückgegeben. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.
Bemerkungen
Diese Funktion ist nicht in einer Headerdatei enthalten und muss von Ordnungszahl 395 für MLWinHelpA und 397 für MLWinHelpW aufgerufen werden.
MLWinHelp ist im Wesentlichen ein Wrapper für WinHelp. Es wird versucht, den Pfad zur Hilfedatei abzurufen, die der aktuellen Einstellung der Ui-Sprache entspricht, bevor WinHelp aufgerufen wird. Wenn dies erfolgreich ist, wird dieser Pfad übergeben. Wenn ein Fehler auftritt, wird der Pfad übergeben, auf den lpszHelp zeigt.
Diese Funktion schlägt fehl, wenn sie aus einem beliebigen Kontext, aber vom aktuellen Benutzer aufgerufen wird.
Vor dem Schließen des Fensters, in dem Hilfe angefordert wurde, muss die Anwendung MLWinHelp aufrufen, wobei der uCommand-Parameter auf HELP QUIT festgelegt _ ist. Bis alle Anwendungen dies getan haben, wird Windows Hilfe nicht beendet. Beachten Sie, dass das Aufrufen Windows Hilfe mit dem _ HELP QUIT-Befehl nicht erforderlich ist, wenn Sie den Befehl HELP _ CONTEXTPOPUP verwendet haben, um Windows Hilfe zu starten.
Die folgende Tabelle zeigt die möglichen Werte für den uCommand-Parameter und die entsprechenden Formate des dwData-Parameters.
| uCommand | Aktion | dwData |
|---|---|---|
| _HILFEBEFEHL | Führt ein Hilfemakro oder eine Makrozeichenfolge aus. | Adresse einer Zeichenfolge, die den Namen der auszuführenden Hilfemakros angibt. Wenn die Zeichenfolge mehrere Makronamen angibt, müssen die Namen durch Semikolons getrennt werden. Sie müssen die Kurzform des Makronamens für einige Makros verwenden, da Windows Hilfe den langen Namen nicht unterstützt. |
| _HILFEINHALTE | Zeigt das Thema an, das von der Option Inhalt im [ Abschnitt OPTIONEN ] der HPJ-Datei angegeben wird. Dieser Befehl dient der Abwärtskompatibilität. Neue Anwendungen sollten eine CNT-Datei bereitstellen und den _ HELP FINDER-Befehl verwenden. | Ignoriert; auf 0 festgelegt. |
| _HILFEKONTEXT | Zeigt das Thema an, das durch den angegebenen Kontextbezeichner identifiziert wird, der im [ ] MAP-Abschnitt der HPJ-Datei definiert ist. | Enthält den Kontextbezeichner für das Thema. |
| HELP _ CONTEXTMENU | Zeigt das Menü Hilfe für das ausgewählte Fenster und dann das Thema für das ausgewählte Steuerelement in einem Popupfenster an. | Adresse eines Arrays von DWORD-Paaren. Das erste DWORD in jedem Paar ist der Steuerelementbezeichner, und das zweite ist der Kontextbezeichner für das Thema. Das Array muss durch ein Paar von Nullen beendet {0,0} werden. Wenn Sie einem bestimmten Steuerelement keine Hilfe hinzufügen möchten, legen Sie dessen Kontextbezeichner auf -1 fest. |
| _HILFEKONTEXTPOPUP | Zeigt das Thema an, das durch den angegebenen Kontextbezeichner identifiziert wird, der im [ ] MAP-Abschnitt der HPJ-Datei in einem Popupfenster definiert ist. | Enthält den Kontextbezeichner für ein Thema. |
| HELP _ FINDER | Zeigt das Dialogfeld Hilfethemen an. | Ignoriert; auf 0 festgelegt. |
| HELP _ FORCEFILE | Stellt sicher, dass Windows Hilfe die richtige Hilfedatei anzeigt. Wenn die falsche Hilfedatei angezeigt wird, öffnet Windows Hilfe die richtige. Andernfalls gibt es keine Aktion. | Ignoriert; auf 0 festgelegt. |
| HELP _ HELPONHELP | Zeigt Hilfe zur Verwendung Windows Hilfe an, wenn die Winhlp32.hlp-Datei verfügbar ist. | Ignoriert; auf 0 festgelegt. |
| HELP _ INDEX | Zeigt das Thema an, das von der Option Inhalt im [ Abschnitt OPTIONEN ] der HPJ-Datei angegeben wird. Dieser Befehl dient der Abwärtskompatibilität. Neue Anwendungen sollten den _ HELP FINDER-Befehl verwenden. | Ignoriert; auf 0 festgelegt. |
| _HILFESCHLÜSSEL | Zeigt das Thema in der Schlüsselworttabelle an, das mit dem angegebenen Schlüsselwort übereinstimmt, wenn eine genaue Übereinstimmung vorliegt. Wenn mehrere Übereinstimmungen vorhanden sind, zeigt den Index mit den Themen an, die im Listenfeld Themen gefunden aufgeführt sind. | Adresse einer Schlüsselwortzeichenfolge. Mehrere Schlüsselwörter müssen durch Semikolons getrennt werden. |
| HELP _ MULTIKEY | Zeigt das durch ein Schlüsselwort angegebene Thema in einer alternativen Schlüsselworttabelle an. | Adresse einer MULTIKEYHELP-Struktur, die ein Tabellennotenzeichen und ein Schlüsselwort angibt. |
| HELP _ PARTIALKEY | Zeigt das Thema in der Schlüsselworttabelle an, das mit dem angegebenen Schlüsselwort übereinstimmt, wenn eine genaue Übereinstimmung vorliegt. Wenn mehrere Übereinstimmungen vorhanden sind, wird das Dialogfeld Themen gefunden angezeigt. Um den Index anzuzeigen, ohne ein Schlüsselwort zu übergeben, verwenden Sie einen Zeiger auf eine leere Zeichenfolge. | Adresse einer Schlüsselwortzeichenfolge. Mehrere Schlüsselwörter müssen durch Semikolons getrennt werden. |
| HELP _ QUIT | Informiert Windows Hilfe darüber, dass sie nicht mehr benötigt wird. Wenn keine anderen Anwendungen um Hilfe gebeten haben, schließt Windows Windows Hilfe. | Ignoriert; auf 0 festgelegt. |
| HELP _ SETCONTENTS | Gibt das Thema Inhalt an. Windows In der Hilfe wird dieses Thema angezeigt, wenn der Benutzer auf die Schaltfläche Inhalt klickt, wenn der Hilfedatei keine CNT-Datei zugeordnet ist. | Enthält den Kontextbezeichner für das Thema Inhalt. |
| HELP _ SETPOPUP _ POS | Legt die Position des nachfolgenden Popupfensters fest. | Enthält die Positionsdaten. Verwenden Sie das MAKELONG-Makro, um die horizontalen und vertikalen Koordinaten zu einem einzelnen Wert zu verketten. Das Popupfenster wird so positioniert, als ob sich der Mauszeiger an dem angegebenen Punkt befand, an dem das Popupfenster aufgerufen wurde. |
| HELP _ SETWINPOS | Zeigt das Windows Hilfefensters an, wenn es minimiert oder im Arbeitsspeicher ist, und legt dessen Größe und Position wie angegeben fest. | Adresse einer HELPWININFO-Struktur, die die Größe und Position eines primären oder sekundären Hilfefensters angibt. |
| _HILFE-TCARD | Gibt an, dass ein Befehl für eine Trainingskarteninstanz von Windows Help vorgesehen ist. Kombinieren Sie diesen Befehl mit anderen Befehlen, indem Sie den bitweisen OR-Operator verwenden. | Hängt vom Befehl ab, mit dem dieser Befehl kombiniert wird. |
| HILFE _ _ WM-HILFE | Zeigt das Thema für das Steuerelement an, das durch den hWndMain-Parameter in einem Popupfenster identifiziert wird. | Adresse eines Arrays von DWORD-Paaren. Das erste DWORD in jedem Paar ist ein Steuerelementbezeichner, und das zweite ist ein Kontextbezeichner für ein Thema. Das Array muss durch ein Paar von Nullen beendet {0,0} werden. Wenn Sie einem bestimmten Steuerelement keine Hilfe hinzufügen möchten, legen Sie dessen Kontextbezeichner auf -1 fest. |
Anforderungen
| Anforderung | Wert |
|---|---|
| Unterstützte Mindestversion (Client) |
Windows 2000 Professional, nur Windows [ XP-Desktop-Apps] |
| Unterstützte Mindestversion (Server) |
Windows Nur Server [ 2003-Desktop-Apps] |
| Header |
|
| DLL |
|
| Unicode- und ANSI-Name |
MLWinHelpW (Unicode) und MLWinHelpA (ANSI) |