LocalDBStopInstance-Funktion

Artikel
05/23/2023

Gilt für: SQL Server

Beendet die angegebene SQL Server Express LocalDB-Instanz.

Headerdatei: msoledbsql.h

Syntax

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

Parameter

pInstanceName
[Eingabe] Der Name der LocalDB-Instanz, die angehalten werden soll.

dwFlags
[Eingabe] Ein Flagwert oder eine Kombination der Flagwerte, die den Weg zum Beenden der Instanz angibt.

Verfügbare Flags:

LOCALDB_SHUTDOWN_KILL_PROCESS
Sofortiges Herunterfahren unter Verwendung des Betriebssystembefehls zum Beenden von Prozessen.

LOCALDB_SHUTDOWN_WITH_NOWAIT
Herunterfahren mithilfe des Transact-SQL-Befehls der WITH NOWAIT-Option.

Wenn keines der Flags festgelegt ist, wird die LocalDB-Instanz mithilfe des Transact-SQL-Befehls SHUTDOWN heruntergefahren. Wenn beide Flags festgelegt sind, hat das LOCALDB_SHUTDOWN_KILL_PROCESS-Flag Vorrang.

ulTimeout
[Eingabe] Die Wartezeit in Sekunden, bis dieser Vorgang abgeschlossen ist. Wenn dieser Wert 0 beträgt, kehrt diese Funktion sofort zurück, ohne zu warten, bis die LocalDB-Instanz beendet ist.

Gibt zurück

S_OK
Die Funktion wurde erfolgreich ausgeführt.

LOCALDB_ERROR_NOT_INSTALLED
SQL Server Express LocalDB ist nicht auf dem Computer installiert.

LOCALDB_ERROR_INVALID_PARAMETER
Mindestens ein angegebener Eingabeparameter ist ungültig.

LOCALDB_ERROR_INVALID_INSTANCE_NAME
Der angegebene Instanzname ist ungültig.

LOCALDB_ERROR_UNKNOWN_INSTANCE
Die Instanz ist nicht vorhanden.

LOCALDB_ERROR_WAIT_TIMEOUT
Beim versuchten Abrufen der Synchronisierungssperren ist ein Timeout aufgetreten.

LOCALDB_ERROR_INSTANCE_STOP_FAILED
Der Beendigungsvorgang wurde nicht innerhalb der angegebenen Zeit abgeschlossen.

LOCALDB_ERROR_INSTANCE_FOLDER_PATH_TOO_LONG
Der Pfad, unter dem die Instanz gespeichert werden soll, ist länger als MAX_PATH.

LOCALDB_ERROR_CANNOT_GET_USER_PROFILE_FOLDER
Ein Benutzerprofilordner kann nicht abgerufen werden.

LOCALDB_ERROR_CANNOT_ACCESS_INSTANCE_FOLDER
Auf einen Instanzordner kann nicht zugegriffen werden.

LOCALDB_ERROR_CANNOT_ACCESS_INSTANCE_REGISTRY
Auf eine Instanzregistrierung kann nicht zugegriffen werden.

LOCALDB_ERROR_INSTANCE_CONFIGURATION_CORRUPT
Eine Instanzkonfiguration ist beschädigt.

LOCALDB_ERROR_CALLER_IS_NOT_OWNER
API-Aufrufer ist kein Eigentümer der LocalDB-Instanz.

LOCALDB_ERROR_INTERNAL_ERROR
Ein unerwarteter Fehler ist aufgetreten. Weitere Informationen finden Sie im Ereignisprotokoll.

Hinweise

Ein Codebeispiel, in dem die LocalDB-API verwendet wird, finden Sie unter SQL Server Express LocalDB Reference.

Weitere Informationen

SQL Server Express LocalDB-Header und -Versionsinformationen

Freigeben über