LocalDBFormatMessage 関数

適用対象:SQL Server

指定した SQL Server Express LocalDB エラーについてのローカライズされた説明テキストを返します。

ヘッダー ファイル: msoledbsql.h

構文

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

パラメーター

hrLocalDB
[入力] LocalDB のエラー コード。

dwFlags
[入力] この関数の動作を指定するフラグ。

使用できるフラグ:

LOCALDB_TRUNCATE_ERR_MESSAGE
入力バッファーが短かすぎる場合、バッファーに合わせてエラー メッセージが切り捨てられます。

dwLanguageId
[入力] 目的の言語 (LANGID) または 0。0 の場合、Win32 FormatMessage 言語順序が使用されます。

wszMessage
[出力] LocalDB エラー メッセージを格納するバッファー。

lpcchMessage
[入力/出力]入力時には、 wszMessage バッファーのサイズが文字で格納されます。 出力側では、所定のバッファー サイズが小さすぎる場合、末尾の NULL も含め、必要なバッファー サイズ (単位は文字数) を格納します。 関数を正常に実行できた場合、このメッセージ内の文字数を格納します。ただし、末尾の NULL は除外します。

戻り値

S_OK
関数が正常に実行されました。

LOCALDB_ERROR_NOT_INSTALLED
SQL Server Express LocalDB は、コンピューターにインストールされていません。

LOCALDB_ERROR_INVALID_PARAMETER
指定した 1 つまたは複数の入力パラメーターが無効です。

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 ヘッダーとバージョン情報