Win32 API 日本語リファレンス
ホームNetworking.ActiveDirectory › DsGetDcNextW

DsGetDcNextW

関数
DC検出列挙で次のドメインコントローラー情報を取得する。
DLLNETAPI32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD DsGetDcNextW(
    HANDLE GetDcContextHandle,
    DWORD* SockAddressCount,   // optional
    SOCKET_ADDRESS** SockAddresses,   // optional
    LPWSTR* DnsHostName   // optional
);

パラメーター

名前方向説明
GetDcContextHandleHANDLEinDsGetDcOpenWで取得したDC列挙コンテキストハンドル。
SockAddressCountDWORD*outoptional返されたソケットアドレスの個数を受け取る出力。
SockAddressesSOCKET_ADDRESS**outoptional次のDCのソケットアドレス配列へのポインタを受け取る出力。使用後はLocalFreeで解放する。
DnsHostNameLPWSTR*outoptional次のDCのDNSホスト名文字列へのポインタを受け取る出力。使用後はLocalFreeで解放する。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DsGetDcNextW(
    HANDLE GetDcContextHandle,
    DWORD* SockAddressCount,   // optional
    SOCKET_ADDRESS** SockAddresses,   // optional
    LPWSTR* DnsHostName   // optional
);
[DllImport("NETAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint DsGetDcNextW(
    IntPtr GetDcContextHandle,   // HANDLE
    IntPtr SockAddressCount,   // DWORD* optional, out
    IntPtr SockAddresses,   // SOCKET_ADDRESS** optional, out
    IntPtr DnsHostName   // LPWSTR* optional, out
);
<DllImport("NETAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function DsGetDcNextW(
    GetDcContextHandle As IntPtr,   ' HANDLE
    SockAddressCount As IntPtr,   ' DWORD* optional, out
    SockAddresses As IntPtr,   ' SOCKET_ADDRESS** optional, out
    DnsHostName As IntPtr   ' LPWSTR* optional, out
) As UInteger
End Function
' GetDcContextHandle : HANDLE
' SockAddressCount : DWORD* optional, out
' SockAddresses : SOCKET_ADDRESS** optional, out
' DnsHostName : LPWSTR* optional, out
Declare PtrSafe Function DsGetDcNextW Lib "netapi32" ( _
    ByVal GetDcContextHandle As LongPtr, _
    ByVal SockAddressCount As LongPtr, _
    ByVal SockAddresses As LongPtr, _
    ByVal DnsHostName As LongPtr) 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

DsGetDcNextW = ctypes.windll.netapi32.DsGetDcNextW
DsGetDcNextW.restype = wintypes.DWORD
DsGetDcNextW.argtypes = [
    wintypes.HANDLE,  # GetDcContextHandle : HANDLE
    ctypes.POINTER(wintypes.DWORD),  # SockAddressCount : DWORD* optional, out
    ctypes.c_void_p,  # SockAddresses : SOCKET_ADDRESS** optional, out
    ctypes.c_void_p,  # DnsHostName : LPWSTR* optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
DsGetDcNextW = Fiddle::Function.new(
  lib['DsGetDcNextW'],
  [
    Fiddle::TYPE_VOIDP,  # GetDcContextHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # SockAddressCount : DWORD* optional, out
    Fiddle::TYPE_VOIDP,  # SockAddresses : SOCKET_ADDRESS** optional, out
    Fiddle::TYPE_VOIDP,  # DnsHostName : LPWSTR* optional, out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "netapi32")]
extern "system" {
    fn DsGetDcNextW(
        GetDcContextHandle: *mut core::ffi::c_void,  // HANDLE
        SockAddressCount: *mut u32,  // DWORD* optional, out
        SockAddresses: *mut *mut SOCKET_ADDRESS,  // SOCKET_ADDRESS** optional, out
        DnsHostName: *mut *mut u16  // LPWSTR* optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("NETAPI32.dll", CharSet = CharSet.Unicode)]
public static extern uint DsGetDcNextW(IntPtr GetDcContextHandle, IntPtr SockAddressCount, IntPtr SockAddresses, IntPtr DnsHostName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_DsGetDcNextW' -Namespace Win32 -PassThru
# $api::DsGetDcNextW(GetDcContextHandle, SockAddressCount, SockAddresses, DnsHostName)
#uselib "NETAPI32.dll"
#func global DsGetDcNextW "DsGetDcNextW" wptr, wptr, wptr, wptr
; DsGetDcNextW GetDcContextHandle, varptr(SockAddressCount), varptr(SockAddresses), varptr(DnsHostName)   ; 戻り値は stat
; GetDcContextHandle : HANDLE -> "wptr"
; SockAddressCount : DWORD* optional, out -> "wptr"
; SockAddresses : SOCKET_ADDRESS** optional, out -> "wptr"
; DnsHostName : LPWSTR* optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "NETAPI32.dll"
#cfunc global DsGetDcNextW "DsGetDcNextW" sptr, var, var, var
; res = DsGetDcNextW(GetDcContextHandle, SockAddressCount, SockAddresses, DnsHostName)
; GetDcContextHandle : HANDLE -> "sptr"
; SockAddressCount : DWORD* optional, out -> "var"
; SockAddresses : SOCKET_ADDRESS** optional, out -> "var"
; DnsHostName : LPWSTR* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD DsGetDcNextW(HANDLE GetDcContextHandle, DWORD* SockAddressCount, SOCKET_ADDRESS** SockAddresses, LPWSTR* DnsHostName)
#uselib "NETAPI32.dll"
#cfunc global DsGetDcNextW "DsGetDcNextW" intptr, var, var, var
; res = DsGetDcNextW(GetDcContextHandle, SockAddressCount, SockAddresses, DnsHostName)
; GetDcContextHandle : HANDLE -> "intptr"
; SockAddressCount : DWORD* optional, out -> "var"
; SockAddresses : SOCKET_ADDRESS** optional, out -> "var"
; DnsHostName : LPWSTR* optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procDsGetDcNextW = netapi32.NewProc("DsGetDcNextW")
)

// GetDcContextHandle (HANDLE), SockAddressCount (DWORD* optional, out), SockAddresses (SOCKET_ADDRESS** optional, out), DnsHostName (LPWSTR* optional, out)
r1, _, err := procDsGetDcNextW.Call(
	uintptr(GetDcContextHandle),
	uintptr(SockAddressCount),
	uintptr(SockAddresses),
	uintptr(DnsHostName),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function DsGetDcNextW(
  GetDcContextHandle: THandle;   // HANDLE
  SockAddressCount: Pointer;   // DWORD* optional, out
  SockAddresses: Pointer;   // SOCKET_ADDRESS** optional, out
  DnsHostName: PPWideChar   // LPWSTR* optional, out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'DsGetDcNextW';
result := DllCall("NETAPI32\DsGetDcNextW"
    , "Ptr", GetDcContextHandle   ; HANDLE
    , "Ptr", SockAddressCount   ; DWORD* optional, out
    , "Ptr", SockAddresses   ; SOCKET_ADDRESS** optional, out
    , "Ptr", DnsHostName   ; LPWSTR* optional, out
    , "UInt")   ; return: DWORD
●DsGetDcNextW(GetDcContextHandle, SockAddressCount, SockAddresses, DnsHostName) = DLL("NETAPI32.dll", "dword DsGetDcNextW(void*, void*, void*, void*)")
# 呼び出し: DsGetDcNextW(GetDcContextHandle, SockAddressCount, SockAddresses, DnsHostName)
# GetDcContextHandle : HANDLE -> "void*"
# SockAddressCount : DWORD* optional, out -> "void*"
# SockAddresses : SOCKET_ADDRESS** optional, out -> "void*"
# DnsHostName : LPWSTR* optional, out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "netapi32" fn DsGetDcNextW(
    GetDcContextHandle: ?*anyopaque, // HANDLE
    SockAddressCount: [*c]u32, // DWORD* optional, out
    SockAddresses: [*c][*c]SOCKET_ADDRESS, // SOCKET_ADDRESS** optional, out
    DnsHostName: [*c][*c]u16 // LPWSTR* optional, out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc DsGetDcNextW(
    GetDcContextHandle: pointer,  # HANDLE
    SockAddressCount: ptr uint32,  # DWORD* optional, out
    SockAddresses: ptr SOCKET_ADDRESS,  # SOCKET_ADDRESS** optional, out
    DnsHostName: ptr WideCString  # LPWSTR* optional, out
): uint32 {.importc: "DsGetDcNextW", stdcall, dynlib: "NETAPI32.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "netapi32");
extern(Windows)
uint DsGetDcNextW(
    void* GetDcContextHandle,   // HANDLE
    uint* SockAddressCount,   // DWORD* optional, out
    SOCKET_ADDRESS** SockAddresses,   // SOCKET_ADDRESS** optional, out
    wchar** DnsHostName   // LPWSTR* optional, out
);
ccall((:DsGetDcNextW, "NETAPI32.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Ptr{UInt32}, Ptr{SOCKET_ADDRESS}, Ptr{Ptr{UInt16}}),
      GetDcContextHandle, SockAddressCount, SockAddresses, DnsHostName)
# GetDcContextHandle : HANDLE -> Ptr{Cvoid}
# SockAddressCount : DWORD* optional, out -> Ptr{UInt32}
# SockAddresses : SOCKET_ADDRESS** optional, out -> Ptr{SOCKET_ADDRESS}
# DnsHostName : LPWSTR* optional, out -> Ptr{Ptr{UInt16}}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t DsGetDcNextW(
    void* GetDcContextHandle,
    uint32_t* SockAddressCount,
    void* SockAddresses,
    uint16_t** DnsHostName);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.DsGetDcNextW(GetDcContextHandle, SockAddressCount, SockAddresses, DnsHostName)
-- GetDcContextHandle : HANDLE
-- SockAddressCount : DWORD* optional, out
-- SockAddresses : SOCKET_ADDRESS** optional, out
-- DnsHostName : LPWSTR* optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('NETAPI32.dll');
const DsGetDcNextW = lib.func('__stdcall', 'DsGetDcNextW', 'uint32_t', ['void *', 'uint32_t *', 'void *', 'void *']);
// DsGetDcNextW(GetDcContextHandle, SockAddressCount, SockAddresses, DnsHostName)
// GetDcContextHandle : HANDLE -> 'void *'
// SockAddressCount : DWORD* optional, out -> 'uint32_t *'
// SockAddresses : SOCKET_ADDRESS** optional, out -> 'void *'
// DnsHostName : LPWSTR* optional, out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NETAPI32.dll", {
  DsGetDcNextW: { parameters: ["pointer", "pointer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.DsGetDcNextW(GetDcContextHandle, SockAddressCount, SockAddresses, DnsHostName)
// GetDcContextHandle : HANDLE -> "pointer"
// SockAddressCount : DWORD* optional, out -> "pointer"
// SockAddresses : SOCKET_ADDRESS** optional, out -> "pointer"
// DnsHostName : LPWSTR* optional, out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t DsGetDcNextW(
    void* GetDcContextHandle,
    uint32_t* SockAddressCount,
    void* SockAddresses,
    uint16_t** DnsHostName);
C, "NETAPI32.dll");
// $ffi->DsGetDcNextW(GetDcContextHandle, SockAddressCount, SockAddresses, DnsHostName);
// GetDcContextHandle : HANDLE
// SockAddressCount : DWORD* optional, out
// SockAddresses : SOCKET_ADDRESS** optional, out
// DnsHostName : LPWSTR* optional, out
// 構造体/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 Netapi32 extends StdCallLibrary {
    Netapi32 INSTANCE = Native.load("netapi32", Netapi32.class, W32APIOptions.UNICODE_OPTIONS);
    int DsGetDcNextW(
        Pointer GetDcContextHandle,   // HANDLE
        IntByReference SockAddressCount,   // DWORD* optional, out
        Pointer SockAddresses,   // SOCKET_ADDRESS** optional, out
        PointerByReference DnsHostName   // LPWSTR* optional, out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("netapi32")]
lib LibNETAPI32
  fun DsGetDcNextW = DsGetDcNextW(
    GetDcContextHandle : Void*,   # HANDLE
    SockAddressCount : UInt32*,   # DWORD* optional, out
    SockAddresses : SOCKET_ADDRESS**,   # SOCKET_ADDRESS** optional, out
    DnsHostName : UInt16**   # LPWSTR* optional, out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DsGetDcNextWNative = Uint32 Function(Pointer<Void>, Pointer<Uint32>, Pointer<Void>, Pointer<Pointer<Utf16>>);
typedef DsGetDcNextWDart = int Function(Pointer<Void>, Pointer<Uint32>, Pointer<Void>, Pointer<Pointer<Utf16>>);
final DsGetDcNextW = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<DsGetDcNextWNative, DsGetDcNextWDart>('DsGetDcNextW');
// GetDcContextHandle : HANDLE -> Pointer<Void>
// SockAddressCount : DWORD* optional, out -> Pointer<Uint32>
// SockAddresses : SOCKET_ADDRESS** optional, out -> Pointer<Void>
// DnsHostName : LPWSTR* optional, out -> Pointer<Pointer<Utf16>>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DsGetDcNextW(
  GetDcContextHandle: THandle;   // HANDLE
  SockAddressCount: Pointer;   // DWORD* optional, out
  SockAddresses: Pointer;   // SOCKET_ADDRESS** optional, out
  DnsHostName: PPWideChar   // LPWSTR* optional, out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'DsGetDcNextW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DsGetDcNextW"
  c_DsGetDcNextW :: Ptr () -> Ptr Word32 -> Ptr () -> Ptr CWString -> IO Word32
-- GetDcContextHandle : HANDLE -> Ptr ()
-- SockAddressCount : DWORD* optional, out -> Ptr Word32
-- SockAddresses : SOCKET_ADDRESS** optional, out -> Ptr ()
-- DnsHostName : LPWSTR* optional, out -> Ptr CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dsgetdcnextw =
  foreign "DsGetDcNextW"
    ((ptr void) @-> (ptr uint32_t) @-> (ptr void) @-> (ptr (ptr uint16_t)) @-> returning uint32_t)
(* GetDcContextHandle : HANDLE -> (ptr void) *)
(* SockAddressCount : DWORD* optional, out -> (ptr uint32_t) *)
(* SockAddresses : SOCKET_ADDRESS** optional, out -> (ptr void) *)
(* DnsHostName : LPWSTR* optional, out -> (ptr (ptr uint16_t)) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library netapi32 (t "NETAPI32.dll"))
(cffi:use-foreign-library netapi32)

(cffi:defcfun ("DsGetDcNextW" ds-get-dc-next-w :convention :stdcall) :uint32
  (get-dc-context-handle :pointer)   ; HANDLE
  (sock-address-count :pointer)   ; DWORD* optional, out
  (sock-addresses :pointer)   ; SOCKET_ADDRESS** optional, out
  (dns-host-name :pointer))   ; LPWSTR* optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DsGetDcNextW = Win32::API::More->new('NETAPI32',
    'DWORD DsGetDcNextW(HANDLE GetDcContextHandle, LPVOID SockAddressCount, LPVOID SockAddresses, LPVOID DnsHostName)');
# my $ret = $DsGetDcNextW->Call($GetDcContextHandle, $SockAddressCount, $SockAddresses, $DnsHostName);
# GetDcContextHandle : HANDLE -> HANDLE
# SockAddressCount : DWORD* optional, out -> LPVOID
# SockAddresses : SOCKET_ADDRESS** optional, out -> LPVOID
# DnsHostName : LPWSTR* optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
使用する型