Функция LocalDBStopInstance
Область применения: SQL Server
Останавливает указанный запущенный экземпляр SQL Server Express LocalDB.
Файл заголовка: msoledbsql.h
Синтаксис
HRESULT LocalDBStopInstance(
PCWSTR pInstanceName,
DWORD dwFlags,
ULONG ulTimeout
);
Параметры
pInstanceName
[Вход] Имя останавливаемого экземпляра LocalDB.
dwFlags
[Вход] Значение или сочетание значений флагов, задающее способ остановки экземпляра.
Доступные флаги:
LOCALDB_SHUTDOWN_KILL_PROCESS
Завершает работу немедленно с помощью команды уничтожения процесса операционной системы.
LOCALDB_SHUTDOWN_WITH_NOWAIT
Завершает работу с использованием параметра WITH NOWAIT команды Transact-SQL.
Если ни один из флагов не установлен, работа экземпляра LocalDB завершается с помощью команды Transact-SQL SHUTDOWN. Если установлены оба флага, приоритет имеет флаг LOCALDB_SHUTDOWN_KILL_PROCESS.
ulTimeout
[Вход] Время ожидания выполнения операции в секундах. Если это значение равно 0, функция немедленно возвращает управление, не ожидая остановки локального экземпляра LocalDB.
Возвраты
S_OK
Функция выполнена успешно.
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
Произошла непредвиденная ошибка. Подробные сведения см. в журнале событий.
Замечания
Образец кода, использующего API LocalDB, см. в разделе SQL Server Express LocalDB Reference