LocalDBFormatMessage, fonction

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

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

Syntaxe

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

Paramètres

hrLocalDB
[Entrée] Code d’erreur 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 est tronqué pour s’adapter à la mémoire tampon.

dwLanguageId
[Entrée] Langue souhaitée (LANGID) ou 0, auquel cas l’ordre de langue Win32 FormatMessage est utilisé.

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

lpcchMessage
[Entrée/sortie] Lors de l’entrée, la taille de la mémoire tampon wszMessage est en caractères. En sortie, si la taille de mémoire tampon donnée est trop petite, contient la taille de la mémoire tampon requise dans les caractères, y compris les valeurs null de fin. Si la fonction réussit, contient le nombre de caractères dans le message, à l’exclusion des valeurs Null 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
La mémoire tampon d’entrée wszMessage est trop courte 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.

Remarques

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

Voir aussi

Informations sur l’en-tête et la version SQL Server Express LocalDB