Fonction LocalDBFormatMessage

Article
07/04/2024

S’applique à : SQL Server

Retourne la description textuelle localisée pour l'erreur SQL Server Express LocalDB spécifiée.

Fichier d’en-tête : msoledbsql.h

Syntaxe

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

Paramètres

hrLocalDB
[Entrée] Code d'erreur de LocalDB.

dwFlags
[Entrée] Indicateurs spécifiant le comportement de cette fonction.

Indicateurs disponibles :

LOCALDB_TRUNCATE_ERR_MESSAGE
Si la mémoire tampon d'entrée est trop courte, le message d'erreur sera tronqué pour s'adapter à la mémoire tampon.

dwLanguageId
[Entrée] Langue souhaitée (LANGID) ou 0, auquel cas l'ordre du langage Win32 FormatMessage est utilisé.

wszMessage
[Sortie] Mémoire tampon pour stocker le message d'erreur de LocalDB.

lpcchMessage
[Entrée/sortie] En entrée contient la taille de la mémoire tampon de wszMessage en caractères. En sortie, si la taille de la mémoire tampon donnée est trop petite, contient la taille de la mémoire tampon requise en caractères, y compris les zéros de fin. Si la fonction réussit, contient le nombre de caractères du message, à l'exception des zéros de fin.

Retours

S_OK
La fonction a réussi.

LOCALDB_ERROR_NOT_INSTALLED
SQL Server Express LocalDB n'est pas installé sur l'ordinateur.

LOCALDB_ERROR_INVALID_PARAMETER
Un ou plusieurs paramètres d'entrée spécifiés ne sont pas valides.

LOCALDB_ERROR_UNKNOWN_ERROR_CODE
Le message demandé n'existe pas.

LOCALDB_ERROR_UNKNOWN_LANGUAGE_ID
Le message n'est pas disponible dans la langue demandée.

LOCALDB_ERROR_INSUFFICIENT_BUFFER
Le tampon d'entrée wszMessage est trop court, et la troncation n'est pas demandée.

LOCALDB_ERROR_INTERNAL_ERROR
Une erreur inattendue s’est produite. Pour plus d'informations, consultez le journal des événements.

Notes

Pour un exemple de code qui utilise l'API LocalDB, consultez SQL Server Express LocalDB Reference.

Voir aussi

En-tête et informations de version de la base de données locale SQL Server Express

Partager via