Applies to:SQL Server
停止指定的 SQL Server Express LocalDB 實例執行。
Header file:msoledbsql.h
Syntax
HRESULT LocalDBStopInstance(
PCWSTR pInstanceName ,
DWORD dwFlags ,
ULONG ulTimeout
);
Arguments
pInstanceName
[輸入]要停止的LocalDB實例名稱。
dwFlags
[輸入]旗標值的其中一個或組合,指定停止實例的方式。
Available flags:
LOCALDB_SHUTDOWN_KILL_PROCESS
使用終止進程作系統命令立即關閉。
LOCALDB_SHUTDOWN_WITH_NOWAIT
使用 WITH NOWAIT 選項 Transact-SQL 命令關閉。
如果未設定任何旗標,則會使用 SHUTDOWN Transact-SQL 命令關閉 LocalDB 實例。 如果同時設定這兩個旗標,旗標會 LOCALDB_SHUTDOWN_KILL_PROCESS 優先使用。
ulTimeout
[輸入]等候此作業完成的秒數。 如果此值為 0,則此函式會立即傳回,而不需要等待LocalDB實例停止。
Returns
S_OK:函式成功。
| Error | Description |
|---|---|
| LOCALDB_ERROR_NOT_INSTALLED | 計算機上未安裝 SQL Server Express LocalDB。 |
| LOCALDB_ERROR_INVALID_PARAMETER | 一或多個指定的輸入參數無效。 |
| 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 | 發生未預期的錯誤。 如需詳細資訊,請參閱事件記錄檔。 |
Remarks
如需使用 LocalDB API 的程式碼範例,請參閱 SQL Server Express LocalDB 參考。