LocalDBFormatMessage 函数

返回指定 SQL Server Express LocalDB 错误的本地化文本说明。

头文件: sqlncli.h

语法

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

参数

hrLocalDB
[输入]LocalDB 错误代码。

dwFlags
[输入]指定此函数行为的标志。

可用标志:

LOCALDB_TRUNCATE_ERR_MESSAGE
如果输入缓冲区太短,将截断错误消息以适应缓冲区。

dwLanguageId
[输入]所需语言(LANGID)或 0,在这种情况下使用 Win32 FormatMessage 语言顺序。

wszMessage
[输出]用于存储 LocalDB 错误消息的缓冲区。

lpcchMessage
[输入/输出]在输入中包含 wszMessage 缓冲区的大小(以字符为单位)。 在输出中,如果给定的缓冲区大小太小,则包含字符所需的缓冲区大小,包括任何尾随 null。 如果函数成功,则包含消息中的字符数,不包括任何尾随 null。

退货

S_OK
函数成功。

LOCALDB_ERROR_NOT_INSTALLED
计算机上未安装 SQL Server Express LocalDB。

LOCALDB_ERROR_INVALID_PARAMETER
一个或多个指定的输入参数无效。

LOCALDB_ERROR_UNKNOWN_ERROR_CODE
请求的消息不存在。

LOCALDB_ERROR_UNKNOWN_LANGUAGE_ID
消息在请求的语言中不可用。

LOCALDB_ERROR_INSUFFICIENT_BUFFER
输入缓冲区 wszMessage 太短,并且不请求截断。

LOCALDB_ERROR_INTERNAL_ERROR
发生意外错误。 有关详细信息,请参阅事件日志。

注解

有关使用 LocalDB API 的代码示例,请参阅 SQL Server Express LocalDB 参考

另请参阅

SQL Server Express LocalDB 标头和版本信息