LocalDBFormatMessage-Funktion

Gilt für: SQL Server

Gibt die lokalisierte Textbeschreibung für den angegebenen SQL Server Express LocalDB-Fehler zurück.

Headerdatei: msoledbsql.h

Syntax

HRESULT LocalDBFormatMessage(  
           HRESULT hrLocalDB,  
           DWORD dwFlags,   
           DWORD dwLanguageId,   
           LPWSTR wszMessage,   
           LPDWORD lpcchMessage   
);  

Parameter

hrLocalDB
[Eingabe] Der LocalDB-Fehlercode.

dwFlags
[Eingabe] Die Flags, die das Verhalten dieser Funktion angeben.

Verfügbare Flags:

LOCALDB_TRUNCATE_ERR_MESSAGE
Wenn der Eingabepuffer zu kurz ist, wird die Fehlermeldung abgeschnitten, damit sie in den Puffer passt.

dwLanguageId
[Eingabe] Die gewünschte Sprache (LANGID) oder 0, falls die Win32 FormatMessage-Sprachreihenfolge verwendet wird.

wszMessage
[Ausgabe] Der Puffer zum Speichern der LocalDB-Fehlermeldung.

lpcchMessage
[Eingabe/Ausgabe] Bei Eingabe enthält dieses Objekt die Größe des wszMessage -Puffers in Zeichen. 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. Wenn die Funktion erfolgreich ausgeführt wird, enthält dieses Objekt die Anzahl der Zeichen in der Meldung, ohne nachfolgende Nullen.

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_UNKNOWN_ERROR_CODE
Die angeforderte Meldung ist nicht vorhanden.

LOCALDB_ERROR_UNKNOWN_LANGUAGE_ID
Die Meldung ist in der angeforderten Sprache nicht verfügbar.

LOCALDB_ERROR_INSUFFICIENT_BUFFER
Der Eingabepuffer wszMessage ist zu kurz. Abschneiden wird nicht angefordert.

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