Partager via


LocalDBFormatMessage function

Applies to:SQL Server

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

Header file:msoledbsql.h

Syntax

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

Arguments

hrLocalDB

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

dwFlags

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

Available flags:

LOCALDB_TRUNCATE_ERR_MESSAGE

Si la mémoire tampon d’entrée est trop courte, le message d’erreur est 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

[Input/Output] On input, this option contains the size of the wszMessage buffer in characters. 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, cette option contient le nombre de caractères dans le message, à l’exclusion des valeurs null de fin.

Returns

S_OK: la fonction a réussi.

Error Description
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 The input buffer wszMessage is too short, and truncation isn't requested.
LOCALDB_ERROR_INTERNAL_ERROR Une erreur inattendue s’est produite. Pour plus d'informations, consultez le journal des événements.

Remarks

Pour obtenir un exemple de code qui utilise l’API LocalDB, consultez la référence SQL Server Express LocalDB.