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

DsGetDcNameA

関数
指定ドメインのドメインコントローラーを検出し情報を返す。
DLLNETAPI32.dll文字セットANSI (-A)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// NETAPI32.dll  (ANSI / -A)
#include <windows.h>

DWORD DsGetDcNameA(
    LPCSTR ComputerName,   // optional
    LPCSTR DomainName,   // optional
    GUID* DomainGuid,   // optional
    LPCSTR SiteName,   // optional
    DWORD Flags,
    DOMAIN_CONTROLLER_INFOA** DomainControllerInfo
);

パラメーター

名前方向説明
ComputerNameLPCSTRinoptional問い合わせを実行するDC名/コンピュータ名を指すANSI文字列。ローカルで実行する場合はNULL可。
DomainNameLPCSTRinoptional検索対象ドメイン名(DNSまたはNetBIOS)を指すANSI文字列。NULLでプライマリドメインを使用。
DomainGuidGUID*inoptional対象ドメインのGUIDへのポインタ。改名対応のフォールバック用で不要ならNULL可。
SiteNameLPCSTRinoptionalDC選択時に優先するサイト名を指すANSI文字列。指定不要ならNULL可。
FlagsDWORDinDC検索の挙動を制御するDS_*ビットフラグ。書き込み可能DCや強制再検出等を指定する。
DomainControllerInfoDOMAIN_CONTROLLER_INFOA**out検出したDC情報構造体へのポインタを受け取る出力。使用後はNetApiBufferFreeで解放する。

戻り値の型: DWORD

各言語での呼び出し定義

// NETAPI32.dll  (ANSI / -A)
#include <windows.h>

DWORD DsGetDcNameA(
    LPCSTR ComputerName,   // optional
    LPCSTR DomainName,   // optional
    GUID* DomainGuid,   // optional
    LPCSTR SiteName,   // optional
    DWORD Flags,
    DOMAIN_CONTROLLER_INFOA** DomainControllerInfo
);
[DllImport("NETAPI32.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint DsGetDcNameA(
    [MarshalAs(UnmanagedType.LPStr)] string ComputerName,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string DomainName,   // LPCSTR optional
    IntPtr DomainGuid,   // GUID* optional
    [MarshalAs(UnmanagedType.LPStr)] string SiteName,   // LPCSTR optional
    uint Flags,   // DWORD
    IntPtr DomainControllerInfo   // DOMAIN_CONTROLLER_INFOA** out
);
<DllImport("NETAPI32.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function DsGetDcNameA(
    <MarshalAs(UnmanagedType.LPStr)> ComputerName As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> DomainName As String,   ' LPCSTR optional
    DomainGuid As IntPtr,   ' GUID* optional
    <MarshalAs(UnmanagedType.LPStr)> SiteName As String,   ' LPCSTR optional
    Flags As UInteger,   ' DWORD
    DomainControllerInfo As IntPtr   ' DOMAIN_CONTROLLER_INFOA** out
) As UInteger
End Function
' ComputerName : LPCSTR optional
' DomainName : LPCSTR optional
' DomainGuid : GUID* optional
' SiteName : LPCSTR optional
' Flags : DWORD
' DomainControllerInfo : DOMAIN_CONTROLLER_INFOA** out
Declare PtrSafe Function DsGetDcNameA Lib "netapi32" ( _
    ByVal ComputerName As String, _
    ByVal DomainName As String, _
    ByVal DomainGuid As LongPtr, _
    ByVal SiteName As String, _
    ByVal Flags As Long, _
    ByVal DomainControllerInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DsGetDcNameA = ctypes.windll.netapi32.DsGetDcNameA
DsGetDcNameA.restype = wintypes.DWORD
DsGetDcNameA.argtypes = [
    wintypes.LPCSTR,  # ComputerName : LPCSTR optional
    wintypes.LPCSTR,  # DomainName : LPCSTR optional
    ctypes.c_void_p,  # DomainGuid : GUID* optional
    wintypes.LPCSTR,  # SiteName : LPCSTR optional
    wintypes.DWORD,  # Flags : DWORD
    ctypes.c_void_p,  # DomainControllerInfo : DOMAIN_CONTROLLER_INFOA** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NETAPI32.dll')
DsGetDcNameA = Fiddle::Function.new(
  lib['DsGetDcNameA'],
  [
    Fiddle::TYPE_VOIDP,  # ComputerName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # DomainName : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # DomainGuid : GUID* optional
    Fiddle::TYPE_VOIDP,  # SiteName : LPCSTR optional
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # DomainControllerInfo : DOMAIN_CONTROLLER_INFOA** out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "netapi32")]
extern "system" {
    fn DsGetDcNameA(
        ComputerName: *const u8,  // LPCSTR optional
        DomainName: *const u8,  // LPCSTR optional
        DomainGuid: *mut GUID,  // GUID* optional
        SiteName: *const u8,  // LPCSTR optional
        Flags: u32,  // DWORD
        DomainControllerInfo: *mut *mut DOMAIN_CONTROLLER_INFOA  // DOMAIN_CONTROLLER_INFOA** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("NETAPI32.dll", CharSet = CharSet.Ansi)]
public static extern uint DsGetDcNameA([MarshalAs(UnmanagedType.LPStr)] string ComputerName, [MarshalAs(UnmanagedType.LPStr)] string DomainName, IntPtr DomainGuid, [MarshalAs(UnmanagedType.LPStr)] string SiteName, uint Flags, IntPtr DomainControllerInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NETAPI32_DsGetDcNameA' -Namespace Win32 -PassThru
# $api::DsGetDcNameA(ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo)
#uselib "NETAPI32.dll"
#func global DsGetDcNameA "DsGetDcNameA" sptr, sptr, sptr, sptr, sptr, sptr
; DsGetDcNameA ComputerName, DomainName, varptr(DomainGuid), SiteName, Flags, varptr(DomainControllerInfo)   ; 戻り値は stat
; ComputerName : LPCSTR optional -> "sptr"
; DomainName : LPCSTR optional -> "sptr"
; DomainGuid : GUID* optional -> "sptr"
; SiteName : LPCSTR optional -> "sptr"
; Flags : DWORD -> "sptr"
; DomainControllerInfo : DOMAIN_CONTROLLER_INFOA** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "NETAPI32.dll"
#cfunc global DsGetDcNameA "DsGetDcNameA" str, str, var, str, int, var
; res = DsGetDcNameA(ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo)
; ComputerName : LPCSTR optional -> "str"
; DomainName : LPCSTR optional -> "str"
; DomainGuid : GUID* optional -> "var"
; SiteName : LPCSTR optional -> "str"
; Flags : DWORD -> "int"
; DomainControllerInfo : DOMAIN_CONTROLLER_INFOA** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD DsGetDcNameA(LPCSTR ComputerName, LPCSTR DomainName, GUID* DomainGuid, LPCSTR SiteName, DWORD Flags, DOMAIN_CONTROLLER_INFOA** DomainControllerInfo)
#uselib "NETAPI32.dll"
#cfunc global DsGetDcNameA "DsGetDcNameA" str, str, var, str, int, var
; res = DsGetDcNameA(ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo)
; ComputerName : LPCSTR optional -> "str"
; DomainName : LPCSTR optional -> "str"
; DomainGuid : GUID* optional -> "var"
; SiteName : LPCSTR optional -> "str"
; Flags : DWORD -> "int"
; DomainControllerInfo : DOMAIN_CONTROLLER_INFOA** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procDsGetDcNameA = netapi32.NewProc("DsGetDcNameA")
)

// ComputerName (LPCSTR optional), DomainName (LPCSTR optional), DomainGuid (GUID* optional), SiteName (LPCSTR optional), Flags (DWORD), DomainControllerInfo (DOMAIN_CONTROLLER_INFOA** out)
r1, _, err := procDsGetDcNameA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(ComputerName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(DomainName))),
	uintptr(DomainGuid),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(SiteName))),
	uintptr(Flags),
	uintptr(DomainControllerInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function DsGetDcNameA(
  ComputerName: PAnsiChar;   // LPCSTR optional
  DomainName: PAnsiChar;   // LPCSTR optional
  DomainGuid: PGUID;   // GUID* optional
  SiteName: PAnsiChar;   // LPCSTR optional
  Flags: DWORD;   // DWORD
  DomainControllerInfo: Pointer   // DOMAIN_CONTROLLER_INFOA** out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'DsGetDcNameA';
result := DllCall("NETAPI32\DsGetDcNameA"
    , "AStr", ComputerName   ; LPCSTR optional
    , "AStr", DomainName   ; LPCSTR optional
    , "Ptr", DomainGuid   ; GUID* optional
    , "AStr", SiteName   ; LPCSTR optional
    , "UInt", Flags   ; DWORD
    , "Ptr", DomainControllerInfo   ; DOMAIN_CONTROLLER_INFOA** out
    , "UInt")   ; return: DWORD
●DsGetDcNameA(ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo) = DLL("NETAPI32.dll", "dword DsGetDcNameA(char*, char*, void*, char*, dword, void*)")
# 呼び出し: DsGetDcNameA(ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo)
# ComputerName : LPCSTR optional -> "char*"
# DomainName : LPCSTR optional -> "char*"
# DomainGuid : GUID* optional -> "void*"
# SiteName : LPCSTR optional -> "char*"
# Flags : DWORD -> "dword"
# DomainControllerInfo : DOMAIN_CONTROLLER_INFOA** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "netapi32" fn DsGetDcNameA(
    ComputerName: [*c]const u8, // LPCSTR optional
    DomainName: [*c]const u8, // LPCSTR optional
    DomainGuid: [*c]GUID, // GUID* optional
    SiteName: [*c]const u8, // LPCSTR optional
    Flags: u32, // DWORD
    DomainControllerInfo: [*c][*c]DOMAIN_CONTROLLER_INFOA // DOMAIN_CONTROLLER_INFOA** out
) callconv(std.os.windows.WINAPI) u32;
proc DsGetDcNameA(
    ComputerName: cstring,  # LPCSTR optional
    DomainName: cstring,  # LPCSTR optional
    DomainGuid: ptr GUID,  # GUID* optional
    SiteName: cstring,  # LPCSTR optional
    Flags: uint32,  # DWORD
    DomainControllerInfo: ptr DOMAIN_CONTROLLER_INFOA  # DOMAIN_CONTROLLER_INFOA** out
): uint32 {.importc: "DsGetDcNameA", stdcall, dynlib: "NETAPI32.dll".}
pragma(lib, "netapi32");
extern(Windows)
uint DsGetDcNameA(
    const(char)* ComputerName,   // LPCSTR optional
    const(char)* DomainName,   // LPCSTR optional
    GUID* DomainGuid,   // GUID* optional
    const(char)* SiteName,   // LPCSTR optional
    uint Flags,   // DWORD
    DOMAIN_CONTROLLER_INFOA** DomainControllerInfo   // DOMAIN_CONTROLLER_INFOA** out
);
ccall((:DsGetDcNameA, "NETAPI32.dll"), stdcall, UInt32,
      (Cstring, Cstring, Ptr{GUID}, Cstring, UInt32, Ptr{DOMAIN_CONTROLLER_INFOA}),
      ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo)
# ComputerName : LPCSTR optional -> Cstring
# DomainName : LPCSTR optional -> Cstring
# DomainGuid : GUID* optional -> Ptr{GUID}
# SiteName : LPCSTR optional -> Cstring
# Flags : DWORD -> UInt32
# DomainControllerInfo : DOMAIN_CONTROLLER_INFOA** out -> Ptr{DOMAIN_CONTROLLER_INFOA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t DsGetDcNameA(
    const char* ComputerName,
    const char* DomainName,
    void* DomainGuid,
    const char* SiteName,
    uint32_t Flags,
    void* DomainControllerInfo);
]]
local netapi32 = ffi.load("netapi32")
-- netapi32.DsGetDcNameA(ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo)
-- ComputerName : LPCSTR optional
-- DomainName : LPCSTR optional
-- DomainGuid : GUID* optional
-- SiteName : LPCSTR optional
-- Flags : DWORD
-- DomainControllerInfo : DOMAIN_CONTROLLER_INFOA** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NETAPI32.dll');
const DsGetDcNameA = lib.func('__stdcall', 'DsGetDcNameA', 'uint32_t', ['str', 'str', 'void *', 'str', 'uint32_t', 'void *']);
// DsGetDcNameA(ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo)
// ComputerName : LPCSTR optional -> 'str'
// DomainName : LPCSTR optional -> 'str'
// DomainGuid : GUID* optional -> 'void *'
// SiteName : LPCSTR optional -> 'str'
// Flags : DWORD -> 'uint32_t'
// DomainControllerInfo : DOMAIN_CONTROLLER_INFOA** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NETAPI32.dll", {
  DsGetDcNameA: { parameters: ["buffer", "buffer", "pointer", "buffer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.DsGetDcNameA(ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo)
// ComputerName : LPCSTR optional -> "buffer"
// DomainName : LPCSTR optional -> "buffer"
// DomainGuid : GUID* optional -> "pointer"
// SiteName : LPCSTR optional -> "buffer"
// Flags : DWORD -> "u32"
// DomainControllerInfo : DOMAIN_CONTROLLER_INFOA** out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t DsGetDcNameA(
    const char* ComputerName,
    const char* DomainName,
    void* DomainGuid,
    const char* SiteName,
    uint32_t Flags,
    void* DomainControllerInfo);
C, "NETAPI32.dll");
// $ffi->DsGetDcNameA(ComputerName, DomainName, DomainGuid, SiteName, Flags, DomainControllerInfo);
// ComputerName : LPCSTR optional
// DomainName : LPCSTR optional
// DomainGuid : GUID* optional
// SiteName : LPCSTR optional
// Flags : DWORD
// DomainControllerInfo : DOMAIN_CONTROLLER_INFOA** 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.ASCII_OPTIONS);
    int DsGetDcNameA(
        String ComputerName,   // LPCSTR optional
        String DomainName,   // LPCSTR optional
        Pointer DomainGuid,   // GUID* optional
        String SiteName,   // LPCSTR optional
        int Flags,   // DWORD
        Pointer DomainControllerInfo   // DOMAIN_CONTROLLER_INFOA** out
    );
}
@[Link("netapi32")]
lib LibNETAPI32
  fun DsGetDcNameA = DsGetDcNameA(
    ComputerName : UInt8*,   # LPCSTR optional
    DomainName : UInt8*,   # LPCSTR optional
    DomainGuid : GUID*,   # GUID* optional
    SiteName : UInt8*,   # LPCSTR optional
    Flags : UInt32,   # DWORD
    DomainControllerInfo : DOMAIN_CONTROLLER_INFOA**   # DOMAIN_CONTROLLER_INFOA** out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DsGetDcNameANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>, Pointer<Utf8>, Uint32, Pointer<Void>);
typedef DsGetDcNameADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>, Pointer<Utf8>, int, Pointer<Void>);
final DsGetDcNameA = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<DsGetDcNameANative, DsGetDcNameADart>('DsGetDcNameA');
// ComputerName : LPCSTR optional -> Pointer<Utf8>
// DomainName : LPCSTR optional -> Pointer<Utf8>
// DomainGuid : GUID* optional -> Pointer<Void>
// SiteName : LPCSTR optional -> Pointer<Utf8>
// Flags : DWORD -> Uint32
// DomainControllerInfo : DOMAIN_CONTROLLER_INFOA** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DsGetDcNameA(
  ComputerName: PAnsiChar;   // LPCSTR optional
  DomainName: PAnsiChar;   // LPCSTR optional
  DomainGuid: PGUID;   // GUID* optional
  SiteName: PAnsiChar;   // LPCSTR optional
  Flags: DWORD;   // DWORD
  DomainControllerInfo: Pointer   // DOMAIN_CONTROLLER_INFOA** out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'DsGetDcNameA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DsGetDcNameA"
  c_DsGetDcNameA :: CString -> CString -> Ptr () -> CString -> Word32 -> Ptr () -> IO Word32
-- ComputerName : LPCSTR optional -> CString
-- DomainName : LPCSTR optional -> CString
-- DomainGuid : GUID* optional -> Ptr ()
-- SiteName : LPCSTR optional -> CString
-- Flags : DWORD -> Word32
-- DomainControllerInfo : DOMAIN_CONTROLLER_INFOA** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dsgetdcnamea =
  foreign "DsGetDcNameA"
    (string @-> string @-> (ptr void) @-> string @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* ComputerName : LPCSTR optional -> string *)
(* DomainName : LPCSTR optional -> string *)
(* DomainGuid : GUID* optional -> (ptr void) *)
(* SiteName : LPCSTR optional -> string *)
(* Flags : DWORD -> uint32_t *)
(* DomainControllerInfo : DOMAIN_CONTROLLER_INFOA** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library netapi32 (t "NETAPI32.dll"))
(cffi:use-foreign-library netapi32)

(cffi:defcfun ("DsGetDcNameA" ds-get-dc-name-a :convention :stdcall) :uint32
  (computer-name :string)   ; LPCSTR optional
  (domain-name :string)   ; LPCSTR optional
  (domain-guid :pointer)   ; GUID* optional
  (site-name :string)   ; LPCSTR optional
  (flags :uint32)   ; DWORD
  (domain-controller-info :pointer))   ; DOMAIN_CONTROLLER_INFOA** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DsGetDcNameA = Win32::API::More->new('NETAPI32',
    'DWORD DsGetDcNameA(LPCSTR ComputerName, LPCSTR DomainName, LPVOID DomainGuid, LPCSTR SiteName, DWORD Flags, LPVOID DomainControllerInfo)');
# my $ret = $DsGetDcNameA->Call($ComputerName, $DomainName, $DomainGuid, $SiteName, $Flags, $DomainControllerInfo);
# ComputerName : LPCSTR optional -> LPCSTR
# DomainName : LPCSTR optional -> LPCSTR
# DomainGuid : GUID* optional -> LPVOID
# SiteName : LPCSTR optional -> LPCSTR
# Flags : DWORD -> DWORD
# DomainControllerInfo : DOMAIN_CONTROLLER_INFOA** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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