IdnToAscii

関数

国際化ドメイン名をUnicodeからASCII(Punycode)へ変換する。

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

シグネチャ

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

INT IdnToAscii(
    DWORD dwFlags,
    LPCWSTR lpUnicodeCharStr,
    INT cchUnicodeChar,
    LPWSTR lpASCIICharStr,   // optional
    INT cchASCIIChar
);

パラメーター

名前

型

方向

説明

dwFlags

DWORD

変換オプションを指定するフラグ。次の表に指定可能な値を示します。

値	意味
IDN_ALLOW_UNASSIGNED	注意比較操作のように、通常の検索用のクエリ文字列として使用しているだけの場合、アプリケーションはこの値を設定できます。ただし、保存用に準備される文字列 (格納される文字列) に対しては、この値を設定しないでください。割り当てられていないコードポイントを入力文字列に含めることを許可します。既定では割り当てられていないコードポイントは許可されず、拡張エラーコード ERROR_INVALID_NAME で失敗します。このフラグにより、現在 IDN では正当でないが、それ以降のバージョンの IDNA 標準では正当となる可能性のある文字を、関数が処理できるようになります。アプリケーションが割り当てられていないコードポイントを Punycode としてエンコードした場合、生成されるドメイン名は不正であるべきです。それ以降のバージョンの IDNA がこれらの名前を正当なものにした場合、またはアプリケーションが不正な文字を除去して正当なドメイン名を作成しようとした場合、セキュリティが損なわれる可能性があります。詳細については、国際化ドメイン名 (IDN) の処理を参照してください。
IDN_USE_STD3_ASCII_RULES	STD3 名で許可されていない ASCII 文字を除去します。入力 Unicode 文字列で許可される ASCII 文字は、英字、数字、およびハイフンマイナスのみです。文字列はハイフンマイナスで開始または終了できません。入力 Unicode 文字列に、ドメイン名に出現できない "["、"]"、"/" などの ASCII 文字が含まれている場合、関数は失敗します。注意一部のローカルネットワークでは、コンピューター名にこれらの文字の一部を許可している場合があります。入力 Unicode 文字列に制御文字 (U+0001 から U+0020) または "delete" 文字 (U+007F) が含まれている場合、関数は失敗します。いずれの場合も、このフラグは Unicode 文字列で許可される非 ASCII 文字には影響しません。
IDN_EMAIL_ADDRESS	Windows 8 以降: 電子メールアドレスのローカル部 (<local>@microsoft.com など) に対して EAI のアルゴリズムによるフォールバックを有効にします。既定では、電子メールアドレスのアドレスまたは構文が無効な場合、この関数は失敗します。アプリケーションはこのフラグを設定することで、電子メールアドレスの国際化 (EAI) を有効にし、可能であれば検出可能なフォールバックアドレスを返すことができます。詳細については、IETF の Email Address Internationalization (eai) Charter を参照してください。
IDN_RAW_PUNYCODE	Windows 8 以降: Punycode の検証とマッピングを無効にします。

lpUnicodeCharStr

LPCWSTR

IDN またはその他の国際化ラベルを表す Unicode 文字列へのポインター。

cchUnicodeChar

INT

lpUnicodeCharStr で示される入力 Unicode 文字列の文字数。

lpASCIICharStr

LPWSTR

outoptional

ASCII 文字セットの文字のみで構成される Unicode 文字列を受け取るバッファーへのポインター。この関数からの戻り時に、バッファーには lpUnicodeCharStr で指定された文字列を Punycode で表した ASCII 文字列が格納されます。あるいは、cchASCIIChar を 0 に設定した場合、このパラメーターに対して関数は NULL を取得できます。この場合、関数はこのバッファーに必要なサイズを返します。

cchASCIIChar

INT

lpASCIICharStr で示されるバッファーのサイズ。アプリケーションはこのパラメーターを 0 に設定して、lpASCIICharStr に NULL を取得できます。

戻り値の型: INT

公式ドキュメント

国際化ドメイン名 (IDN) またはその他の国際化ラベルを、Punycode 転送エンコーディング構文でその名前を表す ASCII 文字列の Unicode (ワイド文字) 表現に変換します。

戻り値

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

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

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

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

解説(Remarks)

終端 null 文字を含めずに入力文字列の長さを明示的に指定した場合、関数は出力文字列を null 終端しません。この関数で出力文字列を null 終端するには、アプリケーションは cchUnicodeChar パラメーターに -1 を指定するか、入力文字列の終端 null 文字を明示的にカウントに含める必要があります。

入力文字列に制御文字 (U+0001 から U+0020) または "delete" 文字 (U+007F) が含まれている場合、関数は常に失敗する点に注意してください。文字 U+0000 は終端 null 文字としてのみ出現できるため、U+0000 が入力文字列の他の場所に出現した場合、関数は常に失敗します。

Windows XP, Windows Server 2003:

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

必要なヘッダーファイルと DLL は Microsoft 国際化ドメイン名 (IDN) 緩和 API の一部であり、これらはダウンロードできなくなりました。

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

各言語での呼び出し定義

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

INT IdnToAscii(
    DWORD dwFlags,
    LPCWSTR lpUnicodeCharStr,
    INT cchUnicodeChar,
    LPWSTR lpASCIICharStr,   // optional
    INT cchASCIIChar
);

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

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

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

import ctypes
from ctypes import wintypes

IdnToAscii = ctypes.windll.normaliz.IdnToAscii
IdnToAscii.restype = ctypes.c_int
IdnToAscii.argtypes = [
    wintypes.DWORD,  # dwFlags : DWORD
    wintypes.LPCWSTR,  # lpUnicodeCharStr : LPCWSTR
    ctypes.c_int,  # cchUnicodeChar : INT
    wintypes.LPWSTR,  # lpASCIICharStr : LPWSTR optional, out
    ctypes.c_int,  # cchASCIIChar : INT
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NORMALIZ.dll')
IdnToAscii = Fiddle::Function.new(
  lib['IdnToAscii'],
  [
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
    Fiddle::TYPE_VOIDP,  # lpUnicodeCharStr : LPCWSTR
    Fiddle::TYPE_INT,  # cchUnicodeChar : INT
    Fiddle::TYPE_VOIDP,  # lpASCIICharStr : LPWSTR optional, out
    Fiddle::TYPE_INT,  # cchASCIIChar : INT
  ],
  Fiddle::TYPE_INT)

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

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

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

出力引数:

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