Función LocalDBFormatMessage

Devuelve la descripción textual localizada del error de SQL Server Express LocalDB especificado.

Archivo de encabezado: sqlncli.h

Sintaxis

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

Parámetros

hrLocalDB
[Entrada] Código de error de LocalDB.

dwFlags
[Entrada] Marcas que especifican el comportamiento de esta función.

Marcas disponibles:

LOCALDB_TRUNCATE_ERR_MESSAGE
Si el búfer de entrada es demasiado corto, el mensaje de error se truncará para ajustarse al búfer.

dwLanguageId
[Entrada] Idioma deseado (LANGID) o 0, en cuyo caso se usa el orden de idioma FormatMessage de Win32.

wszMessage
[Salida] Búfer para almacenar el mensaje de error de LocalDB.

lpcchMessage
[Entrada/salida] En la entrada, contiene el tamaño del búfer wszMessage en caracteres. En la salida, si el tamaño del búfer especificado es demasiado pequeño, contiene el tamaño del búfer necesario en caracteres, incluidos los valores NULL finales. Si la función se ejecuta correctamente, contiene el número de caracteres del mensaje, excepto los valores NULL finales.

Devoluciones

S_OK
La función se ha realizado correctamente.

LOCALDB_ERROR_NOT_INSTALLED
SQL Server Express LocalDB no está instalado en el equipo.

LOCALDB_ERROR_INVALID_PARAMETER
Uno o varios parámetros de entrada especificados no son válidos.

LOCALDB_ERROR_UNKNOWN_ERROR_CODE
El mensaje solicitado no existe.

LOCALDB_ERROR_UNKNOWN_LANGUAGE_ID
El mensaje no está disponible en el idioma solicitado.

LOCALDB_ERROR_INSUFFICIENT_BUFFER
El búfer de entrada wszMessage es demasiado corto y no se solicita el truncamiento.

LOCALDB_ERROR_INTERNAL_ERROR
Error inesperado. Consulte el registro de eventos para obtener más información.

Observaciones

Para obtener un ejemplo de código que usa la API de LocalDB, consulte Referencia de SQL Server Express LocalDB.

Véase también

Información de versiones y encabezados de SQL Server Express LocalDB