Funzione WinHelpA (winuser.h)

  • Articolo

Avvia la Guida di Windows (Winhelp.exe) e passa dati aggiuntivi che indicano la natura della Guida richiesta dall'applicazione.

Sintassi

BOOL WinHelpA(
  HWND      hWndMain,
  LPCSTR    lpszHelp,
  UINT      uCommand,
  ULONG_PTR dwData
);

Parametri

hWndMain

Tipo: HWND

Handle per la finestra che richiede assistenza. La funzione WinHelp usa questo handle per tenere traccia delle applicazioni che hanno richiesto assistenza. Se il parametro uCommand specifica HELP_CONTEXTMENU o HELP_WM_HELP, hWndMain identifica il controllo che richiede assistenza.

lpszHelp

Tipo: LPCTSTR

Indirizzo di una stringa con terminazione Null contenente il percorso, se necessario, e il nome del file della Guida da visualizzare in WinHelp .

Il nome del file può essere seguito da una parentesi angolare (>) e dal nome di una finestra secondaria se l'argomento deve essere visualizzato in una finestra secondaria anziché nella finestra primaria. È necessario definire il nome della finestra secondaria nella sezione [WINDOWS] del file del progetto della Guida (con estensione hpj).

uCommand

Tipo: UINT

Tipo di Guida richiesta. Per un elenco dei valori possibili e su come influiscono sul valore da inserire nel parametro dwData , vedere la sezione Osservazioni.

dwData

Tipo: ULONG_PTR

Dati aggiuntivi. Il valore utilizzato dipende dal valore del parametro uCommand . Per un elenco dei possibili valori dwData , vedere la sezione Osservazioni.

Valore restituito

Tipo: BOOL

Restituisce un valore diverso da zero se l'operazione ha esito positivo o zero in caso contrario. Per recuperare informazioni sull'errore estese, chiamare GetLastError.

Commenti

Prima di chiudere la finestra che ha richiesto la Guida, l'applicazione deve chiamare WinHelp con il parametro uCommand impostato su HELP_QUIT. Fino a quando tutte le applicazioni non hanno eseguito questa operazione, la Guida di Windows non verrà terminata. Si noti che la chiamata alla Guida di Windows con il comando HELP_QUIT non è necessaria se è stato usato il comando HELP_CONTEXTPOPUP per avviare la Guida di Windows.

Questa funzione ha esito negativo se viene chiamato da qualsiasi contesto ma dall'utente corrente.

La tabella seguente illustra i valori possibili per il parametro uCommand e i formati corrispondenti del parametro dwData .

uCommand Azione dwData
HELP_COMMAND Esegue una macro della Guida o una stringa di macro. Indirizzo di una stringa che specifica il nome delle macro della Guida da eseguire. Se la stringa specifica più nomi di macro, i nomi devono essere separati da punti e virgola. È necessario utilizzare la forma breve del nome della macro per alcune macro perché La Guida di Windows non supporta il nome lungo.
HELP_CONTENTS Visualizza l'argomento specificato dall'opzione Contenuto nella sezione [OPTIONS] del file con estensione hpj. Questo comando è destinato alla compatibilità con le versioni precedenti. Le nuove applicazioni devono fornire un file con estensione cnt e usare il comando HELP_FINDER. Ignorato; impostato su 0.
HELP_CONTEXT Visualizza l'argomento identificato dall'identificatore di contesto specificato definito nella sezione [MAP] del file con estensione hpj. Contiene l'identificatore di contesto per l'argomento.
HELP_CONTEXTMENU Visualizza il menu ? per la finestra selezionata, quindi visualizza l'argomento per il controllo selezionato in una finestra popup. Indirizzo di una matrice di coppie DWORD . Il primo DWORD in ogni coppia è l'identificatore del controllo e il secondo è l'identificatore di contesto per l'argomento. La matrice deve essere terminata da una coppia di zeri {0,0}. Se non si vuole aggiungere la Guida a un determinato controllo, impostarne l'identificatore di contesto su -1.
HELP_CONTEXTPOPUP Visualizza l'argomento identificato dall'identificatore di contesto specificato definito nella sezione [MAP] del file con estensione hpj in una finestra popup. Contiene l'identificatore di contesto per un argomento.
HELP_FINDER Visualizza la finestra di dialogo Argomenti della Guida. Ignorato; impostato su 0.
HELP_FORCEFILE Assicura che la Guida di Windows visualizzi il file della Guida corretto. Se viene visualizzato il file della Guida non corretto, la Guida di Windows apre quella corretta; in caso contrario, non è presente alcuna azione. Ignorato; impostato su 0.
HELP_HELPONHELP Visualizza la Guida su come usare la Guida di Windows, se il file Winhlp32.hlp è disponibile. Ignorato; impostato su 0.
HELP_INDEX Visualizza l'argomento specificato dall'opzione Contenuto nella sezione [OPTIONS] del file con estensione hpj. Questo comando è destinato alla compatibilità con le versioni precedenti. Le nuove applicazioni devono usare il comando HELP_FINDER. Ignorato; impostato su 0.
HELP_KEY Visualizza l'argomento nella tabella delle parole chiave corrispondente alla parola chiave specificata, se esiste una corrispondenza esatta. Se sono presenti più corrispondenze, visualizza l'indice con gli argomenti elencati nella casella di riepilogo Argomenti trovati . Indirizzo di una stringa di parole chiave. Più parole chiave devono essere separate da punto e virgola.
HELP_MULTIKEY Visualizza l'argomento specificato da una parola chiave in una tabella di parole chiave alternativa. Indirizzo di una struttura MULTIKEYHELP che specifica un carattere di nota a piè di pagina della tabella e una parola chiave.
HELP_PARTIALKEY Visualizza l'argomento nella tabella delle parole chiave corrispondente alla parola chiave specificata, se esiste una corrispondenza esatta. Se sono presenti più corrispondenze, visualizza la finestra di dialogo Argomenti trovati . Per visualizzare l'indice senza passare una parola chiave, usare un puntatore a una stringa vuota. Indirizzo di una stringa di parole chiave. Più parole chiave devono essere separate da punto e virgola.
HELP_QUIT Informa la Guida di Windows che non è più necessaria. Se nessun'altra applicazione ha richiesto assistenza, Windows chiude la Guida di Windows. Ignorato; impostato su 0.
HELP_SETCONTENTS Specifica l'argomento Contenuto. La Guida di Windows visualizza questo argomento quando l'utente fa clic sul pulsante Contenuto se il file della Guida non dispone di un file con estensione cnt associato. Contiene l'identificatore di contesto per l'argomento Contenuto.
HELP_SETPOPUP_POS Imposta la posizione della finestra popup successiva. Contiene i dati di posizione. Utilizzare MAKELONG per concatenare le coordinate orizzontali e verticali in un singolo valore. La finestra popup viene posizionata come se il cursore del mouse si trovasse nel punto specificato quando è stata richiamata la finestra popup.
HELP_SETWINPOS Visualizza la finestra della Guida di Windows, se ridotta a icona o in memoria e imposta le dimensioni e la posizione come specificato. Indirizzo di una struttura HELPWININFO che specifica le dimensioni e la posizione di una finestra della Guida primaria o secondaria.
HELP_TCARD Indica che un comando è per un'istanza della scheda di training di Windows Help. Combinare questo comando con altri comandi usando l'operatore OR bit per bit. Dipende dal comando con cui viene combinato questo comando.
HELP_WM_HELP Visualizza l'argomento per il controllo identificato dal parametro hWndMain in una finestra popup. Indirizzo di una matrice di coppie DWORD . Il primo DWORD in ogni coppia è un identificatore di controllo e il secondo è un identificatore di contesto per un argomento. La matrice deve essere terminata da una coppia di zero {0,0}. Se non si vuole aggiungere Guida a un controllo specifico, impostare l'identificatore di contesto su -1.
 

Nota

L'intestazione winuser.h definisce WinHelp come alias che seleziona automaticamente la versione ANSI o Unicode di questa funzione in base alla definizione della costante del preprocessore UNICODE. La combinazione dell'utilizzo dell'alias di codifica neutrale con il codice che non è neutrale dalla codifica può causare errori di corrispondenza che causano errori di compilazione o runtime. Per altre informazioni, vedere Convenzioni per i prototipi di funzione.

Requisiti

Requisito Valore
Client minimo supportato Windows XP [solo app desktop]
Server minimo supportato Windows 2000 Server [solo app desktop]
Piattaforma di destinazione Windows
Intestazione Winuser
Libreria User32.lib
DLL User32.dll
Set di API ext-ms-win-ntuser-misc-l1-5-1 (introdotta in Windows 10, versione 10.0.14393)

Vedi anche

HELPWININFO

MULTIKEYHELP