Edit

Share via

LocalDBStopInstance function

Applies to: SQL Server

Stops the specified SQL Server Express LocalDB instance from running.

Header file: msoledbsql.h

Syntax

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

Arguments

pInstanceName

[Input] The name of the LocalDB instance to stop.

dwFlags

[Input] One or a combination of the flag values specifying the way to stop the instance.

Available flags:

LOCALDB_SHUTDOWN_KILL_PROCESS

Shut down immediately using the terminate process operating system command.

LOCALDB_SHUTDOWN_WITH_NOWAIT

Shut down using the WITH NOWAIT option Transact-SQL command.

If none of the flags is set, the LocalDB instance will be shut down using the SHUTDOWN Transact-SQL command. If both flags are set, the LOCALDB_SHUTDOWN_KILL_PROCESS flag takes precedence.

ulTimeout

[Input] The time in seconds to wait for this operation to complete. If this value is 0, this function will return immediately without waiting for the LocalDB instance to stop.

Returns

S_OK: The function succeeded.

Error Description
LOCALDB_ERROR_NOT_INSTALLED SQL Server Express LocalDB isn't installed on the computer.
LOCALDB_ERROR_INVALID_PARAMETER One or more specified input parameters are invalid.
LOCALDB_ERROR_INVALID_INSTANCE_NAME The specified instance name is invalid.
LOCALDB_ERROR_UNKNOWN_INSTANCE The instance doesn't exist.
LOCALDB_ERROR_WAIT_TIMEOUT A time-out occurred while trying to acquire the synchronization locks.
LOCALDB_ERROR_INSTANCE_STOP_FAILED The stop operation failed to complete within the given time.
LOCALDB_ERROR_INSTANCE_FOLDER_PATH_TOO_LONG The path where the instance should be stored is longer than MAX_PATH.
LOCALDB_ERROR_CANNOT_GET_USER_PROFILE_FOLDER A user profile folder can't be retrieved.
LOCALDB_ERROR_CANNOT_ACCESS_INSTANCE_FOLDER An instance folder can't be accessed.
LOCALDB_ERROR_CANNOT_ACCESS_INSTANCE_REGISTRY An instance registry can't be accessed.
LOCALDB_ERROR_INSTANCE_CONFIGURATION_CORRUPT An instance configuration is corrupted.
LOCALDB_ERROR_CALLER_IS_NOT_OWNER API caller isn't LocalDB instance owner.
LOCALDB_ERROR_INTERNAL_ERROR An unexpected error occurred. See the event log for details.

Remarks

For a code sample that uses LocalDB API, see SQL Server Express LocalDB reference.

Related content