Función LocalDBFormatMessage

Se aplica a: SQL Server

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

Archivo de encabezado: msoledbsql.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] Marcadores que especifican el comportamiento de esta función.

Marcadores 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 elegido (LANGID) o 0, en cuyo caso se utiliza el orden de idioma FORMATMESSAGE de Win32.

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

lpcchMessage
[Entrada/Salida] Contiene en la entrada el tamaño de búfer de wszMessage en caracteres. En la salida, si el tamaño de búfer proporcionado es demasiado pequeño, contiene el tamaño de búfer necesario en caracteres, lo cual incluye los valores NULL finales. Si la función se realiza 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 más 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 ha solicitado truncamiento.

LOCALDB_ERROR_INTERNAL_ERROR
Se ha producido un error inesperado. Vea el registro de eventos para obtener detalles.

Comentarios

Para obtener un ejemplo de código que utilice LocalDB API, vea SQL Server Express LocalDB Reference.

Consulte también

Información de encabezado y versión de SQL Server Express LocalDB