指定した SQL Server Express LocalDB インスタンスの実行を停止します。
ヘッダー ファイル: sqlncli.h
構文
HRESULT LocalDBStopInstance(
PCWSTR pInstanceName,
DWORD dwFlags,
ULONG ulTimeout
);
パラメーター
pInstanceName
[入力] 停止する LocalDB インスタンスの名前。dwFlags
[入力] インスタンスを停止する方法を指定する 1 つのフラグ値または複数フラグ値の組み合わせ。使用できるフラグ:
LOCALDB_SHUTDOWN_KILL_PROCESS
オペレーティング システム コマンド kill process を使用して、すぐにシャットダウンします。LOCALDB_SHUTDOWN_WITH_NOWAIT
WITH NOWAIT オプション Transact-SQL コマンドを使用して、シャットダウンします。
どのフラグも設定しない場合、LocalDB インスタンスは SHUTDOWN Transact-SQL コマンドを使用してシャットダウンされます。 両方のフラグを設定した場合、LOCALDB_SHUTDOWN_KILL_PROCESS フラグが優先されます。
ulTimeout
[入力] この操作の完了を待機する秒単位の時間。 この値が 0 の場合、この関数は LocalDB インスタンスの停止を待たずにすぐに値を返します。
戻り値
S_OK
関数が正常に実行されました。LOCALDB_ERROR_NOT_INSTALLED
SQL Server Express LocalDB は、コンピューターにインストールされていません。LOCALDB_ERROR_INVALID_PARAMETER
指定した 1 つまたは複数の入力パラメーターが無効です。LOCALDB_ERROR_INVALID_INSTANCE_NAME
指定したインスタンス名は無効です。LOCALDB_ERROR_UNKNOWN_INSTANCE
インスタンスは存在しません。LOCALDB_ERROR_WAIT_TIMEOUT
同期ロックを取得しようとしている間にタイムアウトが発生しました。LOCALDB_ERROR_INSTANCE_STOP_FAILED
停止操作は、指定された時間内に完了できませんでした。LOCALDB_ERROR_INSTANCE_FOLDER_PATH_TOO_LONG
インスタンスを格納するパスの長さが MAX_PATH を超過しています。LOCALDB_ERROR_CANNOT_GET_USER_PROFILE_FOLDER
ユーザー プロファイル フォルダーを取得できません。LOCALDB_ERROR_CANNOT_ACCESS_INSTANCE_FOLDER
インスタンス フォルダーにアクセスできません。LOCALDB_ERROR_CANNOT_ACCESS_INSTANCE_REGISTRY
インスタンス レジストリにアクセスできません。LOCALDB_ERROR_INSTANCE_CONFIGURATION_CORRUPT
インスタンス構成が破損しています。LOCALDB_ERROR_CALLER_IS_NOT_OWNER
API の呼び出し元は、LocalDB インスタンスの所有者ではありません。LOCALDB_ERROR_INTERNAL_ERROR
予期しないエラーが発生しました。 詳細をイベント ログで確認してください。
説明
LocalDB API を使用するコード例については、「SQL Server Express LocalDB リファレンス」を参照してください。