WinHelpW-Funktion (winuser.h)
Startet die Windows-Hilfe (Winhelp.exe) und übergibt zusätzliche Daten, die die Art der von der Anwendung angeforderten Hilfe angibt.
Syntax
BOOL WinHelpW(
HWND hWndMain,
LPCWSTR lpszHelp,
UINT uCommand,
ULONG_PTR dwData
);
Parameter
hWndMain
Typ: HWND-
Ein Handle für das Fenster, das Hilfe anfordert. Die WinHelp--Funktion verwendet dieses Handle, um nachzuverfolgen, welche Anwendungen Hilfe angefordert haben. Wenn der parameter uCommandHELP_CONTEXTMENU oder HELP_WM_HELPangibt, identifiziert hWndMain das Steuerelement, das Hilfe anfordert.
lpszHelp
Typ: LPCTSTR-
Die Adresse einer mit Null beendeten Zeichenfolge, die den Pfad enthält, falls erforderlich, und der Name der Hilfedatei, die WinHelp- angezeigt werden soll.
Auf den Dateinamen kann eine eckige Klammer (>) und der Name eines sekundären Fensters folgen, wenn das Thema nicht im primären Fenster, sondern in einem sekundären Fenster angezeigt werden soll. Sie müssen den Namen des sekundären Fensters im Abschnitt [WINDOWS] der Hilfeprojektdatei (HPJ) definieren.
uCommand
Typ: UINT-
Der Typ der angeforderten Hilfe. Eine Liste der möglichen Werte und deren Auswirkungen auf den Wert, der im dwData--Parameter platziert werden soll, finden Sie im Abschnitt "Hinweise".
dwData
Typ: ULONG_PTR
Zusätzliche Daten. Der verwendete Wert hängt vom Wert des uCommand--Parameters ab. Eine Liste möglicher dwData--Werte finden Sie im Abschnitt "Hinweise".
Rückgabewert
Typ: BOOL-
Gibt "nonzero" zurück, wenn dies erfolgreich ist, oder 0 andernfalls null. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen abzurufen.
Bemerkungen
Bevor Sie das Fenster schließen, das Hilfe angefordert hat, muss die Anwendung WinHelp- aufrufen, wobei der parameter uCommand auf HELP_QUIT festgelegt ist. Bis alle Anwendungen dies getan haben, wird die Windows-Hilfe nicht beendet. 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.
Diese Funktion schlägt fehl, wenn sie aus einem Kontext, aber dem aktuellen Benutzer aufgerufen wird.
In der folgenden Tabelle sind die möglichen Werte für den parameter uCommand und die entsprechenden Formate des dwData-Parameters aufgeführt.
| uCommand- | Aktion | dwData- |
|---|---|---|
| HELP_COMMAND | 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 kurze Form des Makronamens für einige Makros 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 0 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 an und zeigt dann das Thema für das ausgewählte Steuerelement in einem Popupfenster an. | Adresse eines Arrays von DWORD--Paaren. Die erste DWORD- in jedem Paar ist der Steuerelementbezeichner, und der zweite ist der Kontextbezeichner für das Thema. Das Array muss durch ein Nullpaar {0,0}beendet werden. Wenn Sie einem bestimmten Steuerelement keine Hilfe hinzufügen möchten, legen Sie dessen Kontextbezeichner auf -1 fest. |
| HELP_CONTEXTPOPUP | Zeigt das Thema an, das durch den angegebenen Kontextbezeichner identifiziert wird, der im Abschnitt [MAP] 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 die Windows-Hilfe die richtige Hilfedatei anzeigt. Wenn die falsche Hilfedatei angezeigt wird, öffnet die Windows-Hilfe die richtige. andernfalls gibt es keine Aktion. | Ignoriert; auf 0 festgelegt. |
| HELP_HELPONHELP | Zeigt Hilfe zur Verwendung der Windows-Hilfe an, wenn die Datei "Winhlp32.hlp" verfügbar ist. | Ignoriert; auf 0 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 0 festgelegt. |
| HELP_KEY | Zeigt das Thema in der Schlüsselworttabelle an, das 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. | 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 eines MULTIKEYHELP Struktur, die ein Tabellennotenzeichen und ein Schlüsselwort angibt. |
| HELP_PARTIALKEY | Zeigt das Thema in der Schlüsselworttabelle an, das dem angegebenen Schlüsselwort entspricht, wenn eine genaue Übereinstimmung vorhanden ist. 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 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 0 festgelegt. |
| HELP_SETCONTENTS | Gibt das Thema "Inhalt" an. In der Windows-Hilfe wird dieses Thema angezeigt, wenn der Benutzer auf die Schaltfläche Inhalt klickt, wenn die Hilfedatei keine zugeordnete CNT-Datei enthält. | 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 MAKELONG-, um die horizontalen und vertikalen Koordinaten in einen einzelnen Wert zu verketten. Das Popupfenster wird so positioniert, als ob sich der Mauszeiger am angegebenen Punkt befand, 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. | 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 für eine Schulungskarteninstanz der Windows-Hilfe vorgesehen ist. Kombinieren Sie diesen Befehl mit anderen Befehlen mit dem bitweisen OR-Operator. | Hängt vom Befehl ab, mit dem dieser Befehl kombiniert wird. |
| HELP_WM_HELP | Zeigt das Thema für das steuerelement an, das vom hWndMain Parameter in einem Popupfenster identifiziert wird. | Adresse eines Arrays von DWORD--Paaren. Die erste DWORD- in jedem Paar ist ein Steuerelementbezeichner, und die zweite ist ein Kontextbezeichner für ein Thema. Das Array muss durch ein Nullpaar {0,0}beendet werden. Wenn Sie einem bestimmten Steuerelement keine Hilfe hinzufügen möchten, legen Sie dessen Kontextbezeichner auf -1 fest. |
Anmerkung
Der winuser.h-Header definiert WinHelp als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht codierungsneutral ist, kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.
Anforderungen
| Anforderung | Wert |
|---|---|
| mindestens unterstützte Client- | Windows XP [nur Desktop-Apps] |
| mindestens unterstützte Server- | Windows 2000 Server [nur Desktop-Apps] |
| Zielplattform- | Fenster |
| Header- | winuser.h |
| Library | User32.lib |
| DLL- | User32.dll |
| API-Satz | ext-ms-win-ntuser-misc-l1-5-1 (eingeführt in Windows 10, Version 10.0.14393) |