ホーム › Globalization › IdnToNameprepUnicode

IdnToNameprepUnicode

関数

国際化ドメイン名にNameprep正規化を適用する。

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

シグネチャ

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

INT IdnToNameprepUnicode(
    DWORD dwFlags,
    LPCWSTR lpUnicodeCharStr,
    INT cchUnicodeChar,
    LPWSTR lpNameprepCharStr,   // optional
    INT cchNameprepChar
);

パラメーター

名前	型	方向	説明
dwFlags	DWORD	in	変換オプションを指定するフラグ。詳細な定義については、IdnToAscii の dwFlags パラメーターを参照してください。
lpUnicodeCharStr	LPCWSTR	in	IDN またはその他の国際化ラベルを表す Unicode 文字列へのポインター。
cchUnicodeChar	INT	in	lpUnicodeCharStr で示される入力 Unicode 文字列内の Unicode 文字数。
lpNameprepCharStr	LPWSTR	outoptional	NamePrep 処理を通じて変換された入力 Unicode 文字列を受け取るバッファーへのポインター。あるいは、cchNameprepChar を 0 に設定した場合、この関数はこのパラメーターに NULL を取得できます。この場合、関数はこのバッファーに必要なサイズを返します。
cchNameprepChar	INT	in	lpNameprepCharStr で示されるバッファーのサイズ (文字数)。アプリケーションはサイズを 0 に設定することで、lpNameprepCharStr に NULL を取得し、関数に必要なバッファーサイズを返させることができます。

戻り値の型: INT

公式ドキュメント

国際化ドメイン名 (IDN) またはその他の国際化ラベルを、Network Working Group RFC 3491 で規定された NamePrep 形式に変換します。ただし、Punycode への追加変換は行いません。

戻り値

成功した場合、lpNameprepCharStr に取得された文字数を返します。取得された文字列は、入力 Unicode 文字列が null で終端されている場合にのみ null で終端されます。

関数が成功し、cchNameprepChar の値が 0 の場合、関数は必要なサイズを文字数で返します。これには、終端の null 文字が入力バッファーの一部であった場合はその null 文字も含まれます。

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

ERROR_INSUFFICIENT_BUFFER. 指定されたバッファーサイズが十分に大きくなかったか、誤って NULL に設定されていました。
ERROR_INVALID_FLAGS. フラグに指定された値が無効でした。
ERROR_INVALID_NAME. 関数に無効な名前が指定されました。このエラーコードはすべての構文エラーを捕捉する点に注意してください。
ERROR_INVALID_PARAMETER. いずれかのパラメーター値が無効でした。
ERROR_NO_UNICODE_TRANSLATION. 文字列内に無効な Unicode が見つかりました。

解説(Remarks)

IdnToAscii の「解説」を参照してください。

例

NLS: 国際化ドメイン名 (IDN) 変換サンプルは、この関数の使用方法を示しています。

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

各言語での呼び出し定義

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

INT IdnToNameprepUnicode(
    DWORD dwFlags,
    LPCWSTR lpUnicodeCharStr,
    INT cchUnicodeChar,
    LPWSTR lpNameprepCharStr,   // optional
    INT cchNameprepChar
);

[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern int IdnToNameprepUnicode(
    uint dwFlags,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string lpUnicodeCharStr,   // LPCWSTR
    int cchUnicodeChar,   // INT
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpNameprepCharStr,   // LPWSTR optional, out
    int cchNameprepChar   // INT
);

<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function IdnToNameprepUnicode(
    dwFlags As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpUnicodeCharStr As String,   ' LPCWSTR
    cchUnicodeChar As Integer,   ' INT
    <MarshalAs(UnmanagedType.LPWStr)> lpNameprepCharStr As System.Text.StringBuilder,   ' LPWSTR optional, out
    cchNameprepChar As Integer   ' INT
) As Integer
End Function

' dwFlags : DWORD
' lpUnicodeCharStr : LPCWSTR
' cchUnicodeChar : INT
' lpNameprepCharStr : LPWSTR optional, out
' cchNameprepChar : INT
Declare PtrSafe Function IdnToNameprepUnicode Lib "kernel32" ( _
    ByVal dwFlags As Long, _
    ByVal lpUnicodeCharStr As LongPtr, _
    ByVal cchUnicodeChar As Long, _
    ByVal lpNameprepCharStr As LongPtr, _
    ByVal cchNameprepChar As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

IdnToNameprepUnicode = ctypes.windll.kernel32.IdnToNameprepUnicode
IdnToNameprepUnicode.restype = ctypes.c_int
IdnToNameprepUnicode.argtypes = [
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPCWSTR,  # lpUnicodeCharStr : LPCWSTR
    ctypes.c_int,  # cchUnicodeChar : INT
    wintypes.LPWSTR,  # lpNameprepCharStr : LPWSTR optional, out
    ctypes.c_int,  # cchNameprepChar : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
IdnToNameprepUnicode = Fiddle::Function.new(
  lib['IdnToNameprepUnicode'],
  [
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpUnicodeCharStr : LPCWSTR
    Fiddle::TYPE_INT,  # cchUnicodeChar : INT
    Fiddle::TYPE_VOIDP,  # lpNameprepCharStr : LPWSTR optional, out
    Fiddle::TYPE_INT,  # cchNameprepChar : INT
  ],
  Fiddle::TYPE_INT)

#[link(name = "kernel32")]
extern "system" {
    fn IdnToNameprepUnicode(
        dwFlags: u32,  // DWORD
        lpUnicodeCharStr: *const u16,  // LPCWSTR
        cchUnicodeChar: i32,  // INT
        lpNameprepCharStr: *mut u16,  // LPWSTR optional, out
        cchNameprepChar: i32  // INT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern int IdnToNameprepUnicode(uint dwFlags, [MarshalAs(UnmanagedType.LPWStr)] string lpUnicodeCharStr, int cchUnicodeChar, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpNameprepCharStr, int cchNameprepChar);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_IdnToNameprepUnicode' -Namespace Win32 -PassThru
# $api::IdnToNameprepUnicode(dwFlags, lpUnicodeCharStr, cchUnicodeChar, lpNameprepCharStr, cchNameprepChar)

#uselib "KERNEL32.dll"
#func global IdnToNameprepUnicode "IdnToNameprepUnicode" sptr, sptr, sptr, sptr, sptr
; IdnToNameprepUnicode dwFlags, lpUnicodeCharStr, cchUnicodeChar, varptr(lpNameprepCharStr), cchNameprepChar   ; 戻り値は stat
; dwFlags : DWORD -> "sptr"
; lpUnicodeCharStr : LPCWSTR -> "sptr"
; cchUnicodeChar : INT -> "sptr"
; lpNameprepCharStr : LPWSTR optional, out -> "sptr"
; cchNameprepChar : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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