LocalDBStopInstance 函数

停止指定的 SQL Server Express LocalDB 实例运行。

头文件: sqlncli.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 实例将使用 SHUTDOWN Transact-SQL 命令关闭。 如果设置了这两个标志,则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
发生意外错误。 有关详细信息,请参阅事件日志。

注解

有关使用 LocalDB API 的代码示例,请参阅 SQL Server Express LocalDB 参考

另请参阅

SQL Server Express LocalDB 标头和版本信息