InitiateShutdownA, fonction (winreg.h)

Lance un arrêt et un redémarrage de l’ordinateur spécifié et redémarre toutes les applications inscrites pour le redémarrage.

Syntaxe

DWORD InitiateShutdownA(
  [in, optional] LPSTR lpMachineName,
  [in, optional] LPSTR lpMessage,
  [in]           DWORD dwGracePeriod,
  [in]           DWORD dwShutdownFlags,
  [in]           DWORD dwReason
);

Paramètres

[in, optional] lpMachineName

Nom de l’ordinateur à arrêter. Si la valeur de ce paramètre est NULL, l’ordinateur local est arrêté.

[in, optional] lpMessage

Message à afficher dans la boîte de dialogue d’arrêt interactif.

[in] dwGracePeriod

Nombre de secondes à attendre avant d’arrêter l’ordinateur. Si la valeur de ce paramètre est égale à zéro, l’ordinateur est arrêté immédiatement. Cette valeur est limitée à MAX_SHUTDOWN_TIMEOUT.

Si la valeur de ce paramètre est supérieure à zéro et que le paramètre dwShutdownFlags spécifie l’indicateur SHUTDOWN_GRACE_OVERRIDE, la fonction échoue et retourne le code d’erreur ERROR_BAD_ARGUMENTS.

[in] dwShutdownFlags

Un ou plusieurs indicateurs de bits qui spécifient des options pour l’arrêt. Les valeurs suivantes sont définies.

[in] dwReason

Motif de l’arrêt. Ce paramètre doit être l’un des codes de raison d’arrêt du système . Si ce paramètre est égal à zéro, la valeur par défaut est un arrêt non défini enregistré sous la forme « Aucun titre pour cette raison est introuvable ». Par défaut, il s’agit également d’un arrêt non planifié. Selon la configuration du système, un arrêt non planifié déclenche la création d’un fichier qui contient les informations d’état du système, ce qui peut retarder l’arrêt. Par conséquent, n’utilisez pas zéro pour ce paramètre.

Valeur de retour

Si la fonction réussit, elle retourne ERROR_SUCCESS.

Si la fonction échoue, elle retourne l’un des codes d’erreur suivants.

Remarques

Pour arrêter l’ordinateur local, le thread appelant doit disposer du privilège SE_SHUTDOWN_NAME. Pour arrêter un ordinateur distant, le thread appelant doit disposer du privilège SE_REMOTE_SHUTDOWN_NAME sur l’ordinateur distant. Par défaut, les utilisateurs peuvent activer le privilège SE_SHUTDOWN_NAME sur l’ordinateur sur lequel ils sont connectés, et les administrateurs peuvent activer le privilège SE_REMOTE_SHUTDOWN_NAME sur les ordinateurs distants. Pour plus d’informations, consultez Exécution avec des privilèges spéciaux.

Les raisons courantes de l’échec incluent un nom d’ordinateur non valide ou inaccessible ou un privilège insuffisant. L’erreur ERROR_SHUTDOWN_IN_PROGRESS est retournée si un arrêt est déjà en cours sur l’ordinateur spécifié. L’erreur ERROR_NOT_READY peut être retournée si le basculement rapide de l’utilisateur est activé, mais qu’aucun utilisateur n’est connecté.

Une valeur de retour non nulle ne signifie pas que la déconnexion a été ou sera réussie. L’arrêt est un processus asynchrone et peut se produire longtemps après que l’appel d’API a retourné, ou pas du tout. Même si la valeur de délai d’expiration est égale à zéro, l’arrêt peut toujours être abandonné par les applications, les services ou même le système. La valeur de retour non zéro indique que la validation des droits et des paramètres a réussi et que le système a accepté la demande d’arrêt.

Exigences

Voir aussi

arrêter