Función InitiateShutdownA (winreg.h)

Inicia un apagado y reinicio del equipo especificado y reinicia las aplicaciones que se han registrado para el reinicio.

Sintaxis

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

Parámetros

[in, optional] lpMachineName

Nombre del equipo que se va a apagar. Si el valor de este parámetro es NULL, se apaga el equipo local.

[in, optional] lpMessage

Mensaje que se va a mostrar en el cuadro de diálogo de apagado interactivo.

[in] dwGracePeriod

Número de segundos que se deben esperar antes de apagar el equipo. Si el valor de este parámetro es cero, el equipo se apaga inmediatamente. Este valor se limita a MAX_SHUTDOWN_TIMEOUT.

Si el valor de este parámetro es mayor que cero y el parámetro dwShutdownFlags especifica la marca SHUTDOWN_GRACE_OVERRIDE, la función produce un error y devuelve el código de error ERROR_BAD_ARGUMENTS.

[in] dwShutdownFlags

Una o varias marcas de bits que especifican opciones para el apagado. Se definen los valores siguientes.

[in] dwReason

Motivo para iniciar el apagado. Este parámetro debe ser uno de los códigos de motivo de apagado del sistema. Si este parámetro es cero, el valor predeterminado es un apagado indefinido que se registra como "No se encuentra ningún título por este motivo". De forma predeterminada, también es un apagado no planeado. Dependiendo de cómo se configure el sistema, un apagado no planeado desencadena la creación de un archivo que contiene la información de estado del sistema, que puede retrasar el apagado. Por lo tanto, no use cero para este parámetro.

Valor devuelto

Si la función se realiza correctamente, devuelve ERROR_SUCCESS.

Si se produce un error en la función, devuelve uno de los siguientes códigos de error.

Comentarios

Para apagar el equipo local, el subproceso que llama debe tener el privilegio SE_SHUTDOWN_NAME. Para apagar un equipo remoto, el subproceso que llama debe tener el privilegio SE_REMOTE_SHUTDOWN_NAME en el equipo remoto. De forma predeterminada, los usuarios pueden habilitar el privilegio SE_SHUTDOWN_NAME en el equipo en el que han iniciado sesión y los administradores pueden habilitar el privilegio SE_REMOTE_SHUTDOWN_NAME en equipos remotos. Para más información, consulte Ejecución con privilegios especiales.

Entre los motivos comunes del error se incluyen un nombre de equipo no válido o inaccesible o privilegios insuficientes. El error ERROR_SHUTDOWN_IN_PROGRESS se devuelve si un apagado ya está en curso en el equipo especificado. El error ERROR_NOT_READY se puede devolver si el cambio rápido de usuario está habilitado, pero ningún usuario ha iniciado sesión.

Un valor devuelto distinto de cero no significa que el logoff fue o se realizará correctamente. El apagado es un proceso asincrónico y puede producirse mucho después de que se haya devuelto la llamada API, o no en absoluto. Incluso si el valor de tiempo de espera es cero, las aplicaciones, los servicios o incluso el sistema pueden anular el apagado. El valor devuelto distinto de cero indica que la validación de los derechos y los parámetros se realizó correctamente y que el sistema aceptó la solicitud de apagado.

Requisitos

Consulte también

Cerrando