LocalDBStartInstance-Funktion

Startet die angegebene SQL Server Express LocalDB-Instanz.

Headerdatei: sqlncli.h

Syntax

HRESULT LocalDBStartInstance(
           PCWSTR pInstanceName,
           DWORD dwFlags, 
           LPWSTR wszSqlConnection, 
           LPDWORD lpcchSqlConnection 
);

Parameter

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

  • dwFlags
    [Eingabe] Zur künftigen Verwendung reserviert. Muss derzeit auf 0 festgelegt sein.

  • wszSqlConnection
    [Ausgabe] Der Puffer zum Speichern der Verbindungszeichenfolge in der LocalDB-Instanz.

  • lpcchSqlConnection
    [Eingabe/Ausgabe] Bei Eingabe enthält dieses Objekt die Größe des wszSqlConnection-Puffers in Zeichen, einschließlich sämtlicher nachfolgender Nullen. Wenn der angegebene Puffer zu klein ist, enthält dieses Objekt bei Ausgabe die erforderliche Puffergröße in Zeichen, einschließlich sämtlicher nachfolgender Nullen.

Rückgabewerte

Details

Das Verbindungspufferargument (wszSqlConnection) und das Verbindungspuffergrößen-Argument (lpcchSqlConnection) sind optional. In der folgenden Tabelle werden Optionen zum Verwenden dieser Argumente und ihrer Ergebnisse angezeigt.

Puffer

Puffergröße

Sinn

Aktion

NULL

NULL

Benutzer will die Instanz starten und benötigt keinen Pipenamen.

Startet eine Instanz (keine Piperückgabe und keine erforderliche Puffergrößenrückgabe).

NULL

Vorhanden

Benutzer fragt nach der Ausgabepuffergröße. (Im nächsten Aufruf bittet der Benutzer wahrscheinlich um einen tatsächlichen Start.)

Gibt eine erforderliche Puffergröße (kein Start und keine Piperückgabe) zurück. Ergebnis ist S_OK.

Vorhanden

NULL

Nicht zulässig; falsche Eingabe.

Das zurückgegebene Ergebnis ist LOCALDB_ERROR_INVALID_PARAMETER.

Vorhanden

Vorhanden

Der Benutzer möchte die Instanz starten und benötigt den Pipenamen, zu dem nach dem Start eine Verbindung hergestellt wird.

Überprüft die Puffergröße, startet die Instanz und gibt den Pipenamen im Puffer zurück. Das Puffergrößenargument gibt die Länge der Zeichenfolge "server=" zurück, jedoch ohne nachfolgende Nullen.

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

Siehe auch

Konzepte

SQL Server Express LocalDB-Header und Versionsinformationen