Fonction GenerateConsoleCtrlEvent

Envoie un signal spécifié à un groupe de processus de console qui partage la console associée au processus appelant.

Syntaxe

BOOL WINAPI GenerateConsoleCtrlEvent(
  _In_ DWORD dwCtrlEvent,
  _In_ DWORD dwProcessGroupId
);

Paramètres

dwCtrlEvent [entrée]
Le type de signal à générer. Ce paramètre peut prendre les valeurs suivantes.

Valeur	Signification
CTRL_C_EVENT 0	Génère un signal CTRL+C. Ce signal ne peut pas être limité à un groupe de processus spécifique. Si la valeur de la fonction dwProcessGroupId n’est pas différente de zéro, cette fonction aboutit, mais le signal CTRL+C ne sera pas reçu par les processus au sein du groupe de processus spécifié.
CTRL_BREAK_EVENT 1	Génère un signal CTRL+PAUSE.

dwProcessGroupId [entrée]
L’identificateur du groupe de processus à recevoir le signal. Un groupe de processus est créé lorsque l’indicateur CREATE_NEW_PROCESS_GROUP est spécifié dans un appel à la fonction CreateProcess. L’identificateur de processus du nouveau processus est également l’identificateur de groupe de processus d’un nouveau groupe de processus. Le groupe de processus inclut tous les processus descendants du processus racine. Seuls les processus du groupe qui partagent la même console que le processus appelant reçoivent le signal. En d’autres termes, si un processus du groupe crée une nouvelle console, ce processus ne reçoit pas le signal, pas plus que ses descendants.

Si la valeur de ce paramètre est égal à zéro, le signal est généré dans tous les processus qui partagent la console du processus appelant.

Valeur renvoyée

Si la fonction réussit, la valeur de retour est différente de zéro.

Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Notes

La fonction GenerateConsoleCtrlEvent déclenche l’appel des fonctions de gestionnaire de contrôle des processus du groupe cible. Tous les processus de console ont une fonction de gestionnaire par défaut qui appelle la fonction ExitProcess. Un processus de console peut utiliser la fonction SetConsoleCtrlHandler pour installer ou supprimer d’autres fonctions de gestionnaire.

La fonction SetConsoleCtrlHandler peut également activer un attribut héritable qui permet au processus appelant d'ignorer les signaux CTRL+C. Si la fonction GenerateConsoleCtrlEvent envoie un signal CTRL+C à un processus pour lequel cet attribut est activé, les fonctions de gestionnaire de ce processus ne sont pas appelées. Les signaux CTRL+PAUSE déclenchent toujours l’appel des fonctions du gestionnaire.

Spécifications

Client minimal pris en charge	Windows 2000 Professionnel [applications de bureau uniquement]
Serveur minimal pris en charge	Windows 2000 Server [applications de bureau uniquement]
En-tête	ConsoleApi2.h (via WinCon.h, include Windows.h)
Bibliothèque	Kernel32.lib
DLL	Kernel32.dll

Voir aussi

Gestionnaires de contrôle d’une console

Fonctions de console

CreateProcess

ExitProcess

SetConsoleCtrlHandler