Win32 API 日本語リファレンス
ホーム › NetworkManagement.Dns › DnsValidateName_W

DnsValidateName_W

関数
DNS名が指定形式として有効かどうかを検証する(Unicode)。
DLLDNSAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows 2000 以降

シグネチャ

// DNSAPI.dll  (Unicode / -W)
#include <windows.h>

INT DnsValidateName_W(
    LPCWSTR pszName,
    DNS_NAME_FORMAT Format
);

パラメーター

名前型方向説明
pszNameLPCWSTRin調査対象の DNS 名を表す文字列へのポインター。
FormatDNS_NAME_FORMATin調査する名前の形式を指定する DNS_NAME_FORMAT 値。

戻り値の型: INT

公式ドキュメント

DnsValidateName 関数は、指定された DNS 名の状態を検証します。(DnsValidateName_W)

戻り値

DnsValidateName 関数が返す可能性のある値は次のとおりです:

解説(Remarks)

コンピューターホスト (単一ラベル) の状態を検証するには、Format に DnsNameHostnameLabel を指定して DnsValidateName 関数を使用します。

DnsValidateName 関数は、指定された DNS 名にエラーがあるかどうかを段階的に判定し、最初のエラーを見つけた時点で制御を返します。そのため、複数の異なるエラーを含む DNS 名では最初のエラーのみが報告され、それを修正して再度渡すと、今度は 2 番目のエラーが見つかることがあります。

DnsValidateName 関数は、次の順序でエラーを検索します:

  1. DNS 名が次のいずれかに該当する場合、ERROR_INVALID_NAME を返します:
    • 255 オクテットを超えている。
    • 63 オクテットを超えるラベルを含んでいる。
    • 2 つ以上連続するドットを含んでいる。
    • ドット (.) で始まっている。
    • Format に DnsNameDomainLabel または DnsNameHostnameLabel を指定して名前が渡された場合に、ドット (.) を含んでいる。
  2. 次に、DNS 名全体が数字 (0-9) のみで構成されている場合、または DNS 名の最初のラベルが数字 (0-9) のみで構成されている場合、 DnsValidateName は DNS_ERROR_NUMERIC_NAME を返します。ただし、Format に DnsNameDomainLabel または DnsNameDomain が指定されている場合は除きます。
  3. 続いて、DNS 名が次のいずれかに該当する場合、 DnsValidateName は DNS_ERROR_NON_RFC_NAME を返します:
    • 拡張文字または Unicode 文字を 1 つ以上含んでいる。注意 Windows 8 以降: 国際化ドメイン名 (IDN) エンコードが有効になっている場合、DnsValidateName_W はエラーを返しません。
    • アンダースコア (_) を含んでいる。ただし、Format に DnsNameSrvRecord を指定して渡された名前で、アンダースコアがラベルの先頭文字である場合は除きます。
  4. 次に、DNS 名が次のいずれかに該当する場合、 DnsValidateName は DNS_ERROR_INVALID_NAME_CHAR を返します:
    • 空白を含んでいる。
    • 次の無効な文字のいずれかを含んでいる: { | } ~ [ \ ] ^ ' : ; < = > ? & @ ! " # $ % ^ ` ( ) + / ,
    • アスタリスク (*) を含んでいる。ただし、Format に DnsNameWildcard を指定して渡された複数ラベルの名前で、アスタリスクが最初のラベルである場合は除きます。
注意 DnsValidateName が DNS_ERROR_NON_RFC_NAME を返した場合、このエラーは、すべての DNS サーバーがその名前を受け入れるわけではないという警告として扱う必要があります。このエラーを受け取った場合でも、適切に構成されていれば DNS サーバーは渡された名前を受け入れますが (既定の構成では、DNS_ERROR_NON_RFC_NAME が返される名前もそのまま受け入れます)、他の DNS サーバーソフトウェアでは受け入れられない可能性がある点に注意してください。Windows DNS サーバーは NON_RFC_NAMES を処理できます。

DnsValidateName が次のいずれかのエラーを返した場合、pszName は無効なホスト名として扱う必要があります:

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

各言語での呼び出し定義

// DNSAPI.dll  (Unicode / -W)
#include <windows.h>

INT DnsValidateName_W(
    LPCWSTR pszName,
    DNS_NAME_FORMAT Format
);
[DllImport("DNSAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern int DnsValidateName_W(
    [MarshalAs(UnmanagedType.LPWStr)] string pszName,   // LPCWSTR
    int Format   // DNS_NAME_FORMAT
);
<DllImport("DNSAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function DnsValidateName_W(
    <MarshalAs(UnmanagedType.LPWStr)> pszName As String,   ' LPCWSTR
    Format As Integer   ' DNS_NAME_FORMAT
) As Integer
End Function
' pszName : LPCWSTR
' Format : DNS_NAME_FORMAT
Declare PtrSafe Function DnsValidateName_W Lib "dnsapi" ( _
    ByVal pszName As LongPtr, _
    ByVal Format As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DnsValidateName_W = ctypes.windll.dnsapi.DnsValidateName_W
DnsValidateName_W.restype = ctypes.c_int
DnsValidateName_W.argtypes = [
    wintypes.LPCWSTR,  # pszName : LPCWSTR
    ctypes.c_int,  # Format : DNS_NAME_FORMAT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('DNSAPI.dll')
DnsValidateName_W = Fiddle::Function.new(
  lib['DnsValidateName_W'],
  [
    Fiddle::TYPE_VOIDP,  # pszName : LPCWSTR
    Fiddle::TYPE_INT,  # Format : DNS_NAME_FORMAT
  ],
  Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "dnsapi")]
extern "system" {
    fn DnsValidateName_W(
        pszName: *const u16,  // LPCWSTR
        Format: i32  // DNS_NAME_FORMAT
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("DNSAPI.dll", CharSet = CharSet.Unicode)]
public static extern int DnsValidateName_W([MarshalAs(UnmanagedType.LPWStr)] string pszName, int Format);
"@
$api = Add-Type -MemberDefinition $sig -Name 'DNSAPI_DnsValidateName_W' -Namespace Win32 -PassThru
# $api::DnsValidateName_W(pszName, Format)
#uselib "DNSAPI.dll"
#func global DnsValidateName_W "DnsValidateName_W" wptr, wptr
; DnsValidateName_W pszName, Format   ; 戻り値は stat
; pszName : LPCWSTR -> "wptr"
; Format : DNS_NAME_FORMAT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "DNSAPI.dll"
#cfunc global DnsValidateName_W "DnsValidateName_W" wstr, int
; res = DnsValidateName_W(pszName, Format)
; pszName : LPCWSTR -> "wstr"
; Format : DNS_NAME_FORMAT -> "int"
; INT DnsValidateName_W(LPCWSTR pszName, DNS_NAME_FORMAT Format)
#uselib "DNSAPI.dll"
#cfunc global DnsValidateName_W "DnsValidateName_W" wstr, int
; res = DnsValidateName_W(pszName, Format)
; pszName : LPCWSTR -> "wstr"
; Format : DNS_NAME_FORMAT -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dnsapi = windows.NewLazySystemDLL("DNSAPI.dll")
	procDnsValidateName_W = dnsapi.NewProc("DnsValidateName_W")
)

// pszName (LPCWSTR), Format (DNS_NAME_FORMAT)
r1, _, err := procDnsValidateName_W.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszName))),
	uintptr(Format),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // INT
function DnsValidateName_W(
  pszName: PWideChar;   // LPCWSTR
  Format: Integer   // DNS_NAME_FORMAT
): Integer; stdcall;
  external 'DNSAPI.dll' name 'DnsValidateName_W';
result := DllCall("DNSAPI\DnsValidateName_W"
    , "WStr", pszName   ; LPCWSTR
    , "Int", Format   ; DNS_NAME_FORMAT
    , "Int")   ; return: INT
●DnsValidateName_W(pszName, Format) = DLL("DNSAPI.dll", "int DnsValidateName_W(char*, int)")
# 呼び出し: DnsValidateName_W(pszName, Format)
# pszName : LPCWSTR -> "char*"
# Format : DNS_NAME_FORMAT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "dnsapi" fn DnsValidateName_W(
    pszName: [*c]const u16, // LPCWSTR
    Format: i32 // DNS_NAME_FORMAT
) callconv(std.os.windows.WINAPI) i32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc DnsValidateName_W(
    pszName: WideCString,  # LPCWSTR
    Format: int32  # DNS_NAME_FORMAT
): int32 {.importc: "DnsValidateName_W", stdcall, dynlib: "DNSAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "dnsapi");
extern(Windows)
int DnsValidateName_W(
    const(wchar)* pszName,   // LPCWSTR
    int Format   // DNS_NAME_FORMAT
);
ccall((:DnsValidateName_W, "DNSAPI.dll"), stdcall, Int32,
      (Cwstring, Int32),
      pszName, Format)
# pszName : LPCWSTR -> Cwstring
# Format : DNS_NAME_FORMAT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
int32_t DnsValidateName_W(
    const uint16_t* pszName,
    int32_t Format);
]]
local dnsapi = ffi.load("dnsapi")
-- dnsapi.DnsValidateName_W(pszName, Format)
-- pszName : LPCWSTR
-- Format : DNS_NAME_FORMAT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('DNSAPI.dll');
const DnsValidateName_W = lib.func('__stdcall', 'DnsValidateName_W', 'int32_t', ['str16', 'int32_t']);
// DnsValidateName_W(pszName, Format)
// pszName : LPCWSTR -> 'str16'
// Format : DNS_NAME_FORMAT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("DNSAPI.dll", {
  DnsValidateName_W: { parameters: ["buffer", "i32"], result: "i32" },
});
// lib.symbols.DnsValidateName_W(pszName, Format)
// pszName : LPCWSTR -> "buffer"
// Format : DNS_NAME_FORMAT -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t DnsValidateName_W(
    const uint16_t* pszName,
    int32_t Format);
C, "DNSAPI.dll");
// $ffi->DnsValidateName_W(pszName, Format);
// pszName : LPCWSTR
// Format : DNS_NAME_FORMAT
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Dnsapi extends StdCallLibrary {
    Dnsapi INSTANCE = Native.load("dnsapi", Dnsapi.class, W32APIOptions.UNICODE_OPTIONS);
    int DnsValidateName_W(
        WString pszName,   // LPCWSTR
        int Format   // DNS_NAME_FORMAT
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("dnsapi")]
lib LibDNSAPI
  fun DnsValidateName_W = DnsValidateName_W(
    pszName : UInt16*,   # LPCWSTR
    Format : Int32   # DNS_NAME_FORMAT
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DnsValidateName_WNative = Int32 Function(Pointer<Utf16>, Int32);
typedef DnsValidateName_WDart = int Function(Pointer<Utf16>, int);
final DnsValidateName_W = DynamicLibrary.open('DNSAPI.dll')
    .lookupFunction<DnsValidateName_WNative, DnsValidateName_WDart>('DnsValidateName_W');
// pszName : LPCWSTR -> Pointer<Utf16>
// Format : DNS_NAME_FORMAT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DnsValidateName_W(
  pszName: PWideChar;   // LPCWSTR
  Format: Integer   // DNS_NAME_FORMAT
): Integer; stdcall;
  external 'DNSAPI.dll' name 'DnsValidateName_W';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DnsValidateName_W"
  c_DnsValidateName_W :: CWString -> Int32 -> IO Int32
-- pszName : LPCWSTR -> CWString
-- Format : DNS_NAME_FORMAT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dnsvalidatename_w =
  foreign "DnsValidateName_W"
    ((ptr uint16_t) @-> int32_t @-> returning int32_t)
(* pszName : LPCWSTR -> (ptr uint16_t) *)
(* Format : DNS_NAME_FORMAT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dnsapi (t "DNSAPI.dll"))
(cffi:use-foreign-library dnsapi)

(cffi:defcfun ("DnsValidateName_W" dns-validate-name-w :convention :stdcall) :int32
  (psz-name (:string :encoding :utf-16le))   ; LPCWSTR
  (format :int32))   ; DNS_NAME_FORMAT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DnsValidateName_W = Win32::API::More->new('DNSAPI',
    'int DnsValidateName_W(LPCWSTR pszName, int Format)');
# my $ret = $DnsValidateName_W->Call($pszName, $Format);
# pszName : LPCWSTR -> LPCWSTR
# Format : DNS_NAME_FORMAT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目
使用する型