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 缓冲区的大小（以字节数表示）。 输出时，如果给定的缓冲区太小，则包含所需的缓冲区大小（以字符数表示，包括任何尾随空格）。 如果函数成功，则包含消息中的字符数（任何尾随空格除外）。

返回

• 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 标头信息和版本信息