LocalDBStopInstance function

Applies to:SQL Server

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

Header file:msoledbsql.h

Syntax

HRESULT LocalDBStopInstance(
           PCWSTR pInstanceName ,
           DWORD dwFlags ,
           ULONG ulTimeout
);

[输入] 要停止的 LocalDB 实例的名称。

[输入] 指定要停止该实例的方法的一个标志或标志组合。

Available flags:

使用终止进程作系统命令立即关闭。

使用 WITH NOWAIT 选项 Transact-SQL 命令关闭。

如果未设置任何标志，则使用 Transact-SQL 命令关闭 SHUTDOWN LocalDB 实例。如果设置了这两个标志，则 LOCALDB_SHUTDOWN_KILL_PROCESS 标志优先。

[输入] 等待此操作完成的时间（秒）。如果值为此值 0，则此函数将立即返回，而无需等待 LocalDB 实例停止。

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	发生了意外错误。有关详细信息，请参阅事件日志。

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