WinHelpA-Funktion (winuser.h)
Startet die Windows-Hilfe (Winhelp.exe) und übergibt zusätzliche Daten, die die Art der von der Anwendung angeforderten Hilfe angeben.
Syntax
BOOL WinHelpA(
HWND hWndMain,
LPCSTR lpszHelp,
UINT uCommand,
ULONG_PTR dwData
);
Parameter
hWndMain
Typ: HWND
Ein Handle für das Fenster, das Hilfe anfordert. Die WinHelp-Funktion verwendet diesen Handle, um nachzuverfolgen, welche Anwendungen Hilfe angefordert haben. Wenn der uCommand-ParameterHELP_CONTEXTMENU oder HELP_WM_HELP angibt, identifiziert hWndMain das Steuerelement, das Hilfe anfordert.
lpszHelp
Typ: LPCTSTR
Die Adresse einer null-beendeten Zeichenfolge, die ggf. den Pfad und den Namen der Hilfedatei enthält, die WinHelp anzeigen soll.
Auf den Dateinamen können eine eckige 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 Abschnitt [WINDOWS] der Hilfeprojektdatei (HPJ) definieren.
uCommand
Typ: UINT
Die Art 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 der möglichen dwData-Werte finden Sie im Abschnitt Hinweise.
Rückgabewert
Typ: BOOL
Gibt bei erfolgreicher Ausführung nonzero zurück, oder andernfalls null. Rufen Sie GetLastError auf, um erweiterte Fehlerinformationen abzurufen.
Hinweise
Vor dem Schließen des Fensters, in dem Hilfe angefordert wurde, muss die Anwendung WinHelp aufrufen, wobei der uCommand-Parameter 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 beliebigen Kontext außer dem aktuellen Benutzer aufgerufen wird.
Die folgende Tabelle zeigt die möglichen Werte für den uCommand-Parameter und die entsprechenden Formate des dwData-Parameters .
| 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 für einige Makros die Kurzform des Makronamens verwenden, da die Windows-Hilfe den langen Namen nicht unterstützt. |
| HELP_CONTENTS | Zeigt das Durch die Option Inhalt im Abschnitt [OPTIONEN] der HPJ-Datei angegebene Thema an. 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 Menü Hilfe 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 . Das erste DWORD in jedem Paar ist der Steuerelementbezeichner und der zweite der Kontextbezeichner für das Thema. Das Array muss durch ein Nullenpaar {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 Durch die Option Inhalt im Abschnitt [OPTIONEN] der HPJ-Datei angegebene Thema an. 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üsselwort (keyword) Tabelle an, das dem angegebenen Schlüsselwort (keyword) entspricht, 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üsselwort (keyword) Zeichenfolge. Mehrere Schlüsselwörter müssen durch Semikolons getrennt werden. |
| HELP_MULTIKEY | Zeigt das von einem Schlüsselwort (keyword) in einer alternativen Schlüsselwort (keyword) Tabelle angegebene Thema an. | Adresse einer MULTIKEYHELP-Struktur, die ein Tabellenfußnotenzeichen und eine Schlüsselwort (keyword) angibt. |
| HELP_PARTIALKEY | Zeigt das Thema in der Schlüsselwort (keyword) Tabelle an, das dem angegebenen Schlüsselwort (keyword) entspricht, wenn eine genaue Übereinstimmung vorliegt. Wenn mehrere Übereinstimmungen vorhanden sind, wird das Dialogfeld Themen gefunden angezeigt . Um den Index anzuzeigen, ohne einen Schlüsselwort (keyword) zu übergeben, verwenden Sie einen Zeiger auf eine leere Zeichenfolge. | Adresse einer Schlüsselwort (keyword) Zeichenfolge. 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 um Hilfe gebeten 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 zu einem einzelnen Wert zu verketten. Das Popupfenster ist so positioniert, als ob sich der Mauscursor an dem angegebenen Punkt bestrafen, an dem das Popupfenster aufgerufen wurde. |
| HELP_SETWINPOS | Zeigt das Windows-Hilfefenster an, wenn es minimiert ist oder sich im Arbeitsspeicher befindet, 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 Karte instance der Windows-Hilfe 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. |
| HELP_WM_HELP | 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 Nullenpaar {0,0}beendet werden. Wenn Sie einem bestimmten Steuerelement keine Hilfe hinzufügen möchten, legen Sie dessen Kontextbezeichner auf -1 fest. |
Hinweis
Der winuser.h-Header definiert WinHelp als Alias, der die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch 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 |
|---|---|
| Unterstützte Mindestversion (Client) | Windows XP [nur Desktop-Apps] |
| Unterstützte Mindestversion (Server) | Windows 2000 Server [nur Desktop-Apps] |
| Zielplattform | Windows |
| Kopfzeile | winuser.h |
| Bibliothek | User32.lib |
| DLL | User32.dll |
| APIs | ext-ms-win-ntuser-misc-l1-5-1 (eingeführt in Windows 10, Version 10.0.14393) |