InitiateShutdownA 関数 (winreg.h)

指定したコンピューターのシャットダウンと再起動を開始し、再起動のために登録されているアプリケーションをすべて再起動します。

構文

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

パラメーター

[in, optional] lpMachineName

シャットダウンするコンピューターの名前。 このパラメーターの値が NULL の場合、ローカル コンピューターはシャットダウンされます。

[in, optional] lpMessage

対話型シャットダウン ダイアログ ボックスに表示されるメッセージ。

[in] dwGracePeriod

コンピューターをシャットダウンするまでに待機する秒数。 このパラメーターの値が 0 の場合、コンピューターはすぐにシャットダウンされます。 この値は MAX_SHUTDOWN_TIMEOUTに制限されます。

このパラメーターの値が 0 より大きく、 dwShutdownFlags パラメーターで フラグ SHUTDOWN_GRACE_OVERRIDEが指定されている場合、関数は失敗し、 エラー コード ERROR_BAD_ARGUMENTSを返します。

[in] dwShutdownFlags

シャットダウンのオプションを指定する 1 つ以上のビット フラグ。 次の値が定義されています。

[in] dwReason

シャットダウンを開始する理由。 このパラメーターは、 システムシャットダウン理由コードの 1 つである必要があります。 このパラメーターが 0 の場合、既定値は未定義のシャットダウンであり、"この理由でタイトルが見つかりませんでした" としてログに記録されます。 既定として、計画外のシャットダウンもあります。 システムの構成方法に応じて、計画外のシャットダウンによって、システム状態情報を含むファイルの作成がトリガーされ、シャットダウンが遅れる可能性があります。 したがって、このパラメーターには 0 を使用しないでください。

戻り値

関数が成功すると、 ERROR_SUCCESSが返されます。

関数が失敗すると、次のいずれかのエラー コードが返されます。

注釈

ローカル コンピューターをシャットダウンするには、呼び出し元のスレッドにSE_SHUTDOWN_NAME特権が必要です。 リモート コンピューターをシャットダウンするには、呼び出し元のスレッドにリモート コンピューターに対するSE_REMOTE_SHUTDOWN_NAME特権が必要です。 既定では、ユーザーはログオンしているコンピューターでSE_SHUTDOWN_NAME特権を有効にでき、管理者はリモート コンピューターでSE_REMOTE_SHUTDOWN_NAME特権を有効にすることができます。 詳細については、「特別な特権を使用して実行する」を参照してください。

エラーの一般的な理由には、無効なコンピューター名またはアクセスできないコンピューター名、または特権が不十分であることが含まれます。 指定したコンピューターでシャットダウンが既に進行中の場合は、エラー ERROR_SHUTDOWN_IN_PROGRESSが返されます。 高速ユーザー切り替えが有効になっているが、ユーザーがログオンしていない場合は、エラー ERROR_NOT_READYを返すことができます。

0 以外の戻り値は、ログオフが成功したことを意味するものではありません。 シャットダウンは非同期プロセスであり、API 呼び出しが返された後、またはまったく発生しない場合があります。 タイムアウト値が 0 の場合でも、アプリケーション、サービス、またはシステムによってシャットダウンを中止できます。 0 以外の戻り値は、権限とパラメーターの検証が成功し、システムがシャットダウン要求を受け入れたことを示します。

要件

こちらもご覧ください

シャットダウン