MultiByteToWideChar 関数 (stringapiset.h)
文字列を UTF-16 (ワイド文字) 文字列にマップします。 文字列は、必ずしもマルチバイト文字セットからのものではありません。
構文
int MultiByteToWideChar(
[in] UINT CodePage,
[in] DWORD dwFlags,
[in] _In_NLS_string_(cbMultiByte)LPCCH lpMultiByteStr,
[in] int cbMultiByte,
[out, optional] LPWSTR lpWideCharStr,
[in] int cchWideChar
);
パラメーター
[in] CodePage
変換の実行に使用するコード ページ。 このパラメーターは、オペレーティング システムにインストールされているコード ページまたは使用可能なコード ページの値に設定できます。 コード ページの一覧については、「 コード ページ識別子」を参照してください。 アプリケーションでは、次の表に示す値のいずれかを指定することもできます。
[in] dwFlags
変換の種類を示すフラグ。 アプリケーションでは、次の値の組み合わせを指定でき、MB_PRECOMPOSEDが既定値になります。 MB_PRECOMPOSEDとMB_COMPOSITEは相互に排他的です。 MB_USEGLYPHCHARSとMB_ERR_INVALID_CHARSは、他のフラグの状態に関係なく設定できます。
| 値 | 意味 |
|---|---|
|
分解された文字、つまり、基本文字と 1 つ以上の非スペース文字がそれぞれ個別のコード ポイント値を持つ文字を常に使用します。 たとえば、Ä は A + ̈: ラテン大文字 A (U+0041) + COMBINING DIAERESIS (U+0308) で表されます。 このフラグはMB_PRECOMPOSEDで使用できないことに注意してください。 |
|
無効な入力文字が見つかった場合は失敗します。
Windows Vista 以降、アプリケーションがこのフラグを設定していない場合、関数は無効なコード ポイントを削除しませんが、代わりに無効なシーケンスを U+FFFD (指定されたコード ページに応じてエンコード) に置き換えます。 Windows 2000 SP4 以降、Windows XP: このフラグが設定されていない場合、関数は無効なコード ポイントをサイレント モードで削除します。 GetLastError を呼び出すと、ERROR_NO_UNICODE_TRANSLATIONが返されます。 |
|
既定;MB_COMPOSITEでは使用しないでください。 必ず事前計算済み文字 、つまり、基本文字または非スペース文字の組み合わせに対して 1 つの文字値を持つ文字を使用します。 たとえば、文字 è では、e は基本文字で、アクセント のグレーブ マークは非スペース文字です。 1 つの文字に対して 1 つの Unicode コード ポイントが定義されている場合、アプリケーションでは、別の基本文字と非スペース文字の代わりに使用する必要があります。 たとえば、Ä は単一の Unicode コード ポイントのラテン大文字 A WITH DIAERESIS (U+00C4) で表されます。 |
|
コントロール文字の代わりにグリフ文字を使用します。 |
以下に示すコード ページでは、 dwFlags を 0 に設定する必要があります。 それ以外の場合、関数はERROR_INVALID_FLAGSで失敗します。
- 50220
- 50221
- 50222
- 50225
- 50227
- 50229
- 57002 から 57011
- 65000 (UTF-7)
- 42 (記号)
[in] lpMultiByteStr
変換する文字列へのポインター。
[in] cbMultiByte
lpMultiByteStr パラメーターによって示される文字列のサイズ (バイト単位)。 または、文字列が null で終わる場合は、このパラメーターを -1 に設定できます。 cbMultiByte が 0 の場合、関数は失敗します。
このパラメーターが -1 の場合、関数は、終端の null 文字を含む入力文字列全体を処理します。 したがって、結果の Unicode 文字列には終端の null 文字があり、関数によって返される長さにはこの文字が含まれます。
このパラメーターが正の整数に設定されている場合、関数は指定されたバイト数を正確に処理します。 指定されたサイズに終端の null 文字が含まれていない場合、結果の Unicode 文字列は null で終わるのではなく、返される長さにはこの文字は含まれません。
[out, optional] lpWideCharStr
変換された文字列を受け取るバッファーへのポインター。
[in] cchWideChar
lpWideCharStr で示されるバッファーのサイズ (文字単位)。 この値が 0 の場合、関数は必要なバッファー サイズ (終端の null 文字を含む) を文字単位で返し、 lpWideCharStr バッファーを使用しません。
戻り値
成功した場合に lpWideCharStr で示されるバッファーに書き込まれた文字数を返します。 関数が成功し、 cchWideChar が 0 の場合、戻り値は lpWideCharStr で示されるバッファーに必要なサイズ (文字単位) です。 また、無効なシーケンスが入力された場合にMB_ERR_INVALID_CHARS フラグが戻り値に与える影響については、 dwFlags を参照してください。
成功しなかった場合、関数は 0 を返します。 拡張エラー情報を取得するために、アプリケーションは GetLastError を呼び出すことができます。GetLastError は、次のいずれかのエラー コードを返すことができます。
- ERROR_INSUFFICIENT_BUFFER。 指定されたバッファー サイズが十分に大きくないか、 正しく NULL に設定されていませんでした。
- ERROR_INVALID_FLAGS。 フラグに指定された値が無効でした。
- ERROR_INVALID_PARAMETER。 パラメーター値のいずれかが無効です。
- ERROR_NO_UNICODE_TRANSLATION。 文字列に無効な Unicode が見つかりました。
注釈
この関数の既定の動作は、入力文字列の事前計算済みの形式に変換することです。 事前計算済みのフォームが存在しない場合、関数は複合フォームへの変換を試みます。
ほとんどの入力データは既に構成されているため、MB_PRECOMPOSED フラグを使用すると、ほとんどのコード ページにはほとんど影響しません。 MultiByteToWideChar で変換した後に NormalizeString を呼び出す方法を検討してください。 NormalizeString は、より正確で標準の一貫性のあるデータを提供し、高速にすることもできます。 NormalizeString に渡されるNORM_FORM列挙の場合、NormalizC はMB_PRECOMPOSEDに対応し、NormalizD はMB_COMPOSITEに対応することに注意してください。
前述のように、必要なサイズを取得するために cchWideChar を 0 に設定してこの関数を最初に呼び出さない場合は、出力バッファーを簡単にオーバーランできます。 MB_COMPOSITE フラグを使用する場合、出力は各入力文字に対して 3 文字以上の長さにできます。
lpMultiByteStr ポインターと lpWideCharStr ポインターは同じにすることはできません。 同じ場合、関数は失敗し、 GetLastError はERROR_INVALID_PARAMETER値を返します。
入力文字列の長さが null 文字を終了せずに明示的に指定されている場合、MultiByteToWideChar は出力文字列を null で終了しません。 この関数の出力文字列を null 終了するには、アプリケーションで -1 を渡すか、入力文字列の終端の null 文字を明示的にカウントする必要があります。
MB_ERR_INVALID_CHARSが設定され、ソース文字列で無効な文字が見つかった場合、関数は失敗します。 無効な文字は次のいずれかです。
- ソース文字列の既定の文字ではないが、MB_ERR_INVALID_CHARSが設定されていない場合に既定の文字に変換される文字
- DBCS 文字列の場合、先頭バイトは含まれるが有効な後続バイトを持たない文字
Windows XP: UTF-8 文字の最短形式以外のバージョンのセキュリティの問題を防ぐために、 MultiByteToWideChar はこれらの 文字を削除します。
Windows 8以降: MultiByteToWideChar は Stringapiset.h で宣言されています。 Windows 8する前は、Winnls.h で宣言されていました。
コードの例
catch (std::exception e)
{
// Save in-memory logging buffer to a log file on error.
::std::wstring wideWhat;
if (e.what() != nullptr)
{
int convertResult = MultiByteToWideChar(CP_UTF8, 0, e.what(), (int)strlen(e.what()), NULL, 0);
if (convertResult <= 0)
{
wideWhat = L"Exception occurred: Failure to convert its message text using MultiByteToWideChar: convertResult=";
wideWhat += convertResult.ToString()->Data();
wideWhat += L" GetLastError()=";
wideWhat += GetLastError().ToString()->Data();
}
else
{
wideWhat.resize(convertResult + 10);
convertResult = MultiByteToWideChar(CP_UTF8, 0, e.what(), (int)strlen(e.what()), &wideWhat[0], (int)wideWhat.size());
if (convertResult <= 0)
{
wideWhat = L"Exception occurred: Failure to convert its message text using MultiByteToWideChar: convertResult=";
wideWhat += convertResult.ToString()->Data();
wideWhat += L" GetLastError()=";
wideWhat += GetLastError().ToString()->Data();
}
else
{
wideWhat.insert(0, L"Exception occurred: ");
}
}
}
else
{
wideWhat = L"Exception occurred: Unknown.";
}
Platform::String^ errorMessage = ref new Platform::String(wideWhat.c_str());
// The session added the channel at level Warning. Log the message at
// level Error which is above (more critical than) Warning, which
// means it will actually get logged.
_channel->LogMessage(errorMessage, LoggingLevel::Error);
SaveLogInMemoryToFileAsync().then([=](StorageFile^ logFile) {
_logFileGeneratedCount++;
StatusChanged(this, ref new LoggingScenarioEventArgs(LoggingScenarioEventType::LogFileGenerated, logFile->Path->Data()));
}).wait();
}
GitHub の Windows ユニバーサル サンプル の例。
要件
| サポートされている最小のクライアント | Windows 2000 Professional [デスクトップ アプリ |UWP アプリ] |
| サポートされている最小のサーバー | Windows 2000 Server [デスクトップ アプリ |UWP アプリ] |
| 対象プラットフォーム | Windows |
| ヘッダー | stringapiset.h (Windows.h を含む) |
| Library | Kernel32.lib |
| [DLL] | Kernel32.dll |