NormalizeString

関数

Unicode文字列を指定形式で正規化する。

DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

// KERNEL32.dll
#include <windows.h>

INT NormalizeString(
    NORM_FORM NormForm,
    LPCWSTR lpSrcString,
    INT cwSrcLength,
    LPWSTR lpDstString,   // optional
    INT cwDstLength
);

パラメーター

名前	型	方向	説明
NormForm	NORM_FORM	in	使用する正規化形式。NORM_FORM は標準的な Unicode 正規化形式を指定します。
lpSrcString	LPCWSTR	in	正規化されていないソース文字列へのポインター。
cwSrcLength	INT	in	ソース文字列を格納するバッファーの長さ(文字数)。文字列が null 終端であると関数に想定させ、長さを自動的に計算させる場合は、このパラメーターに -1 を設定できます。
lpDstString	LPWSTR	outoptional	関数が変換先文字列を取得するバッファーへのポインター。あるいは、cwDstLength が 0 に設定されている場合、このパラメーターには NULL を指定します。 Note 終端の null 文字を含めずに入力文字列の長さを明示的に指定した場合、関数は文字列を null 終端しません。出力文字列を null 終端するには、アプリケーションは -1 を指定するか、入力文字列の終端 null 文字を明示的に数に含める必要があります。
cwDstLength	INT	in	変換先文字列を格納するバッファーの長さ(文字数)。あるいは、変換先バッファーに必要なサイズを関数に返させるために、このパラメーターに 0 を設定することもできます。

戻り値の型: INT

公式ドキュメント

テキスト文字列の文字を Unicode 4.0 TR#15 に従って正規化します。詳細については、「Using Unicode Normalization to Represent Strings」を参照してください。

戻り値

変換先バッファー内の正規化された文字列の長さを返します。cwDstLength が 0 に設定されている場合、関数は実際の変換に必要なバッファー長の推定値を返します。

入力バッファー内の文字列が null 終端である場合、または cwSrcLength が -1 の場合、変換先バッファーに書き込まれる文字列は null 終端となり、返される文字列長には終端 null 文字が含まれます。

関数が成功しなかった場合は、0 以下の値を返します。拡張エラー情報を取得するには、アプリケーションは GetLastError を呼び出すことができ、次のいずれかのエラーコードが返されることがあります。

ERROR_INSUFFICIENT_BUFFER. 指定されたバッファーサイズが十分な大きさでなかったか、誤って NULL に設定されていました。
ERROR_INVALID_PARAMETER. いずれかのパラメーター値が無効でした。
ERROR_NO_UNICODE_TRANSLATION. 文字列内に無効な Unicode が見つかりました。戻り値は、入力文字列内のエラー発生位置のインデックスの符号を反転した値です。
ERROR_SUCCESS. 処理は正常に完了しましたが、結果は得られませんでした。

解説(Remarks)

一部の Unicode 文字には、結合文字や合成 Unicode 文字の集合からなる、複数の等価なバイナリ表現があります。Unicode 標準では、ある文字の等価なバイナリ表現のいずれかが与えられたときに、1 つのバイナリ表現を返す正規化と呼ばれる処理が定義されています。正規化は、異なる規則に従う正規化形式と呼ばれる複数のアルゴリズムで実行できます。これについては、「Using Unicode Normalization to Represent Strings」で説明されています。Win32 と .NET Framework は現在、Unicode Standard Annex #15: Unicode Normalization Forms で定義されている正規化形式 C、D、KC、KD をサポートしています。正規化された文字列は、通常、序数比較で評価されます。

次のコードは、バッファー長の推定値の使用方法を示しています。

const int maxIterations = 10;
LPWSTR strResult = NULL;
HANDLE hHeap = GetProcessHeap();

int iSizeEstimated = NormalizeString(form, strInput, -1, NULL, 0);
for (int i = 0; i < maxIterations; i++)
{
    if (strResult)
        HeapFree(hHeap, 0, strResult);
    strResult = (LPWSTR)HeapAlloc(hHeap, 0, iSizeEstimated * sizeof (WCHAR));
    iSizeEstimated = NormalizeString(form, strInput, -1, strResult, iSizeEstimated);
 
    if (iSizeEstimated > 0)
        break; // success 
 
    if (iSizeEstimated <= 0)
    {
        DWORD dwError = GetLastError();
        if (dwError != ERROR_INSUFFICIENT_BUFFER) break; // Real error, not buffer error 
 
        // New guess is negative of the return value. 
        iSizeEstimated = -iSizeEstimated;
    }
}

Windows XP、Windows Server 2003:

サポートされなくなりました。

必要なヘッダーファイルと DLL は、Microsoft Internationalized Domain Name (IDN) Mitigation API の一部であり、現在はダウンロードできません。

Examples

この関数の使用例は、「NLS: Unicode Normalization Sample」にあります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

INT NormalizeString(
    NORM_FORM NormForm,
    LPCWSTR lpSrcString,
    INT cwSrcLength,
    LPWSTR lpDstString,   // optional
    INT cwDstLength
);

[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern int NormalizeString(
    int NormForm,   // NORM_FORM
    [MarshalAs(UnmanagedType.LPWStr)] string lpSrcString,   // LPCWSTR
    int cwSrcLength,   // INT
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpDstString,   // LPWSTR optional, out
    int cwDstLength   // INT
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function NormalizeString(
    NormForm As Integer,   ' NORM_FORM
    <MarshalAs(UnmanagedType.LPWStr)> lpSrcString As String,   ' LPCWSTR
    cwSrcLength As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPWStr)> lpDstString As System.Text.StringBuilder,   ' LPWSTR optional, out
    cwDstLength As Integer   ' INT
) As Integer
End Function

' NormForm : NORM_FORM
' lpSrcString : LPCWSTR
' cwSrcLength : INT
' lpDstString : LPWSTR optional, out
' cwDstLength : INT
Declare PtrSafe Function NormalizeString Lib "kernel32" ( _
    ByVal NormForm As Long, _
    ByVal lpSrcString As LongPtr, _
    ByVal cwSrcLength As Long, _
    ByVal lpDstString As LongPtr, _
    ByVal cwDstLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

NormalizeString = ctypes.windll.kernel32.NormalizeString
NormalizeString.restype = ctypes.c_int
NormalizeString.argtypes = [
    ctypes.c_int,  # NormForm : NORM_FORM
    wintypes.LPCWSTR,  # lpSrcString : LPCWSTR
    ctypes.c_int,  # cwSrcLength : INT
    wintypes.LPWSTR,  # lpDstString : LPWSTR optional, out
    ctypes.c_int,  # cwDstLength : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
NormalizeString = Fiddle::Function.new(
  lib['NormalizeString'],
  [
    Fiddle::TYPE_INT,  # NormForm : NORM_FORM
    Fiddle::TYPE_VOIDP,  # lpSrcString : LPCWSTR
    Fiddle::TYPE_INT,  # cwSrcLength : INT
    Fiddle::TYPE_VOIDP,  # lpDstString : LPWSTR optional, out
    Fiddle::TYPE_INT,  # cwDstLength : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn NormalizeString(
        NormForm: i32,  // NORM_FORM
        lpSrcString: *const u16,  // LPCWSTR
        cwSrcLength: i32,  // INT
        lpDstString: *mut u16,  // LPWSTR optional, out
        cwDstLength: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern int NormalizeString(int NormForm, [MarshalAs(UnmanagedType.LPWStr)] string lpSrcString, int cwSrcLength, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpDstString, int cwDstLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_NormalizeString' -Namespace Win32 -PassThru
# $api::NormalizeString(NormForm, lpSrcString, cwSrcLength, lpDstString, cwDstLength)

#uselib "KERNEL32.dll"
#func global NormalizeString "NormalizeString" sptr, sptr, sptr, sptr, sptr
; NormalizeString NormForm, lpSrcString, cwSrcLength, varptr(lpDstString), cwDstLength   ; 戻り値は stat
; NormForm : NORM_FORM -> "sptr"
; lpSrcString : LPCWSTR -> "sptr"
; cwSrcLength : INT -> "sptr"
; lpDstString : LPWSTR optional, out -> "sptr"
; cwDstLength : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "KERNEL32.dll"
#cfunc global NormalizeString "NormalizeString" int, wstr, int, var, int
; res = NormalizeString(NormForm, lpSrcString, cwSrcLength, lpDstString, cwDstLength)
; NormForm : NORM_FORM -> "int"
; lpSrcString : LPCWSTR -> "wstr"
; cwSrcLength : INT -> "int"
; lpDstString : LPWSTR optional, out -> "var"
; cwDstLength : INT -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "KERNEL32.dll"
#cfunc global NormalizeString "NormalizeString" int, wstr, int, sptr, int
; res = NormalizeString(NormForm, lpSrcString, cwSrcLength, varptr(lpDstString), cwDstLength)
; NormForm : NORM_FORM -> "int"
; lpSrcString : LPCWSTR -> "wstr"
; cwSrcLength : INT -> "int"
; lpDstString : LPWSTR optional, out -> "sptr"
; cwDstLength : INT -> "int"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。