Auf Englisch lesen

Freigeben über


MLWinHelp-Funktion

[Diese Funktion ist über Windows XP und Windows Server 2003 verfügbar. In nachfolgenden Versionen von Windows wird sie möglicherweise geändert oder entfernt.]

Startet die 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 mit Null beendeten Zeichenfolge, die, falls erforderlich, den Pfad und den Namen der Hilfedatei enthält, die MLWinHelp anzeigen soll.

Auf den Dateinamen kann eine eckige Klammer (>) und der Name eines sekundären Fensters folgen, wenn das Thema nicht im primären, sondern in einem sekundä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 angeforderte Hilfetyp. Eine Liste der möglichen Werte und ihrer Auswirkungen auf den Wert, der im dwData-Parameter platziert 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 möglicher Werte für dwData finden Sie im Abschnitt „Hinweise“.

Rückgabewert

Typ: BOOL

Gibt einen Wert ungleich Null für Erfolg oder ansonsten Null zurück. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Diese Funktion ist nicht in einer Kopfzeilendatei enthalten und muss von der Ordnungszahl 395 für MLWinHelpA und von der Ordnungszahl 397 für MLWinHelpW aufgerufen werden.

MLWinHelp ist im Wesentlichen eine Umschließung für WinHelp. Sie versucht, den Pfad zur Hilfedatei abzurufen, die der aktuellen Sprache der Benutzeroberfläche entspricht, bevor sie WinHelp aufruft. Wenn dies erfolgreich ist, wird dieser Pfad übergeben. Wenn dies fehlschlägt, wird der Pfad übergeben, der auf lpszHelp verweist.

Diese Funktion schlägt fehl, wenn sie aus einem anderen Kontext als vom aktuellen Benutzer aufgerufen wird.

Bevor die Anwendung das Fenster schließt, das Hilfe angefordert hat, muss sie MLWinHelp aufrufen, wobei der uCommand-Parameter auf „HELP_QUIT“ festgelegt ist. Die Windows-Hilfe wird solange nicht beendet, bis alle Anwendungen dies getan haben. Beachten Sie, dass das Aufrufen der Windows-Hilfe mit dem Befehl „HELP_QUIT“ nicht erforderlich ist, wenn Sie den Befehl „HELP_CONTEXTPOPUP“ zum Starten der Windows-Hilfe verwendet haben.

In der folgenden Tabelle sind die möglichen Werte für den uCommand-Parameter und die entsprechenden Formate des dwData-Parameters aufgeführt.

uCommand Aktion dwData
HELP_COMMAND Führt ein Hilfemakro oder eine Makrozeichenfolge aus. Die Adresse einer Zeichenfolge, die den Namen des oder der auszuführenden Hilfemakros angibt. Wenn die Zeichenfolge mehrere Makronamen angibt, müssen die Namen durch Semikolons getrennt werden. Für manche Makros müssen Sie die Kurzform des Makronamens verwenden, da die Windows-Hilfe den langen Namen nicht unterstützt.
HELP_CONTENTS Zeigt das Thema an, das durch die Option „Inhalt“ im Abschnitt [OPTIONS] der HPJ-Datei angegeben ist. Dieser Befehl dient der Abwärtskompatibilität. Neue Anwendungen sollten eine CNT-Datei bereitstellen und den Befehl „HELP_FINDER“ verwenden. Ignoriert; auf Null festgelegt.
HELP_CONTEXT Zeigt das Thema an, das durch den angegebenen Kontextbezeichner identifiziert wird, der im Abschnitt [MAP] der HPJ-Datei definiert ist. Enthält den Kontextbezeichner für das Thema.
HELP_CONTEXTMENU Zeigt das Hilfemenü für das ausgewählte Fenster und dann das Thema für das ausgewählte Steuerelement in einem Popupfenster an. Die Adresse eines Arrays von DWORD-Paaren. Das erste DWORD in jedem Paar ist der Steuerelementbezeichner, das zweite der Kontextbezeichner für das Thema. Das Array muss durch ein Nullenpaar {0,0} beendet werden. Wenn Sie zu einem bestimmten Steuerelement keine Hilfe hinzufügen möchten, legen Sie dessen Kontextbezeichner auf -1 fest.
HELP_CONTEXTPOPUP Zeigt in einem Popupfenster das Thema an, das durch den angegebenen Kontextbezeichner identifiziert wird, der im Abschnitt [MAP] der HPJ-Datei definiert ist. Enthält den Kontextbezeichner für das Thema.
HELP_FINDER Zeigt das Dialogfeld Hilfethemen an. Ignoriert; auf Null festgelegt.
HELP_FORCEFILE Stellt sicher, dass die Windows-Hilfe die richtige Hilfedatei anzeigt. Wenn die falsche Hilfedatei angezeigt wird, öffnet die Windows-Hilfe die richtige. Andernfalls findet keine Aktion statt. Ignoriert; auf Null festgelegt.
HELP_HELPONHELP Zeigt Hilfe zur Verwendung der Windows-Hilfe an, sofern die Datei „Winhlp32.hlp“ verfügbar ist. Ignoriert; auf Null festgelegt.
HELP_INDEX Zeigt das Thema an, das durch die Option „Inhalt“ im Abschnitt [OPTIONS] der HPJ-Datei angegeben ist. Dieser Befehl dient der Abwärtskompatibilität. Neue Anwendungen sollten den Befehl „HELP_FINDER“ verwenden. Ignoriert; auf Null festgelegt.
HELP_KEY Zeigt das Thema in der Schlüsselworttabelle an, die dem angegebenen Schlüsselwort entspricht, wenn eine genaue Übereinstimmung vorhanden ist. Wenn mehrere Übereinstimmungen vorhanden sind, wird der Index mit den Themen angezeigt, die im Listenfeld Gefundene Themen aufgeführt sind. Die Adresse einer Schlüsselwortzeichenfolge. Mehrere Schlüsselwörter müssen durch Semikolons getrennt werden.
HELP_MULTIKEY Zeigt das von einem Schlüsselwort angegebene Thema in einer alternativen Schlüsselworttabelle an. Die Adresse einer MULTIKEYHELP-Struktur, die ein Tabellenfußnotenzeichen und eine Schlüsselwort angibt.
HELP_PARTIALKEY Zeigt das Thema in der Schlüsselworttabelle an, die dem angegebenen Schlüsselwort entspricht, wenn eine genaue Übereinstimmung vorhanden ist. Wenn mehrere Übereinstimmungen vorhanden sind, wird das Dialogfeld Gefundene Themen angezeigt. Um den Index anzuzeigen, ohne eine Schlüsselwort zu übergeben, verwenden Sie einen Zeiger auf eine leere Zeichenfolge. Die Adresse einer Schlüsselwortzeichenfolge. Mehrere Schlüsselwörter müssen durch Semikolons getrennt werden.
HELP_QUIT Informiert die Windows-Hilfe, dass sie nicht mehr benötigt wird. Wenn keine anderen Anwendungen Hilfe angefordert haben, schließt Windows die Windows-Hilfe. Ignoriert; auf Null festgelegt.
HELP_SETCONTENTS Gibt das Thema von „Inhalt“ an. Die Windows-Hilfe zeigt dieses Thema an, wenn der Benutzer auf die Schaltfläche Inhalt klickt, sofern die Hilfedatei nicht über eine zugeordnete CNT-Datei verfügt. Enthält den Kontextbezeichner für das Thema von „Inhalt“.
HELP_SETPOPUP_POS Legt die Position des nachfolgenden Popupfensters fest. Enthält die Positionsdaten. Verwenden Sie das Makro MAKELONG, um die horizontalen und vertikalen Koordinaten zu einem einzelnen Wert zu verketten. Das Popupfenster wird so positioniert, als wäre der Mauszeiger am angegebenen Punkt, an dem das Popupfenster aufgerufen wurde.
HELP_SETWINPOS Zeigt das Windows-Hilfefenster an, wenn es minimiert oder im Arbeitsspeicher ist, und legt dessen Größe und Position wie angegeben fest. Die Adresse einer HELPWININFO-Struktur, die die Größe und Position eines primären oder sekundären Hilfefensters angibt.
HELP_TCARD Gibt an, dass ein Befehl einer Trainingskarten-Instanz der Windows-Hilfe dient. Kombinieren Sie diesen Befehl mit anderen Befehlen mithilfe des bitweisen ODER-Operators. Hängt vom Befehl ab, mit dem dieser Befehl kombiniert wird.
HELP_WM_HELP Zeigt das Thema für das vom hWndMain-Parameter identifizierten Steuerelement in einem Popupfenster an. Die Adresse eines Arrays von DWORD-Paaren. Das erste DWORD in jedem Paar ist ein Steuerelementbezeichner, das zweite ein Kontextbezeichner für das Thema. Das Array muss durch ein Nullenpaar {0,0} beendet werden. Wenn Sie zu 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, Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)
Windows Server 2003 [nur Desktop-Apps]
Header
Keine
DLL
Shlwapi.dll (Version 5.0 oder höher)
Unicode- und ANSI-Namen
MLWinHelpW (Unicode) und MLWinHelpA (ANSI)

Siehe auch

HELPWININFO

MULTIKEYHELP