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

DsGetDcSiteCoverageW

関数
DCがカバーするサイト名の一覧を取得する。
DLLNETAPI32.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD DsGetDcSiteCoverageW(
    LPCWSTR ServerName,   // optional
    DWORD* EntryCount,
    LPWSTR** SiteNames
);

パラメーター

名前方向説明
ServerNameLPCWSTRinoptionalサイトカバレッジを問い合わせる対象DC名を指すワイド文字列。ローカルの場合はNULL可。
EntryCountDWORD*out返されたサイト名の個数を受け取る出力。
SiteNamesLPWSTR**out対象DCがカバーするサイト名配列へのポインタを受け取る出力。使用後はNetApiBufferFreeで解放する。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DsGetDcSiteCoverageW(
    LPCWSTR ServerName,   // optional
    DWORD* EntryCount,
    LPWSTR** SiteNames
);
[DllImport("NETAPI32.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint DsGetDcSiteCoverageW(
    [MarshalAs(UnmanagedType.LPWStr)] string ServerName,   // LPCWSTR optional
    out uint EntryCount,   // DWORD* out
    IntPtr SiteNames   // LPWSTR** out
);
<DllImport("NETAPI32.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function DsGetDcSiteCoverageW(
    <MarshalAs(UnmanagedType.LPWStr)> ServerName As String,   ' LPCWSTR optional
    <Out> ByRef EntryCount As UInteger,   ' DWORD* out
    SiteNames As IntPtr   ' LPWSTR** out
) As UInteger
End Function
' ServerName : LPCWSTR optional
' EntryCount : DWORD* out
' SiteNames : LPWSTR** out
Declare PtrSafe Function DsGetDcSiteCoverageW Lib "netapi32" ( _
    ByVal ServerName As LongPtr, _
    ByRef EntryCount As Long, _
    ByVal SiteNames 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

DsGetDcSiteCoverageW = ctypes.windll.netapi32.DsGetDcSiteCoverageW
DsGetDcSiteCoverageW.restype = wintypes.DWORD
DsGetDcSiteCoverageW.argtypes = [
    wintypes.LPCWSTR,  # ServerName : LPCWSTR optional
    ctypes.POINTER(wintypes.DWORD),  # EntryCount : DWORD* out
    ctypes.c_void_p,  # SiteNames : LPWSTR** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	netapi32 = windows.NewLazySystemDLL("NETAPI32.dll")
	procDsGetDcSiteCoverageW = netapi32.NewProc("DsGetDcSiteCoverageW")
)

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

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

typedef DsGetDcSiteCoverageWNative = Uint32 Function(Pointer<Utf16>, Pointer<Uint32>, Pointer<Pointer<Utf16>>);
typedef DsGetDcSiteCoverageWDart = int Function(Pointer<Utf16>, Pointer<Uint32>, Pointer<Pointer<Utf16>>);
final DsGetDcSiteCoverageW = DynamicLibrary.open('NETAPI32.dll')
    .lookupFunction<DsGetDcSiteCoverageWNative, DsGetDcSiteCoverageWDart>('DsGetDcSiteCoverageW');
// ServerName : LPCWSTR optional -> Pointer<Utf16>
// EntryCount : DWORD* out -> Pointer<Uint32>
// SiteNames : LPWSTR** out -> Pointer<Pointer<Utf16>>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DsGetDcSiteCoverageW(
  ServerName: PWideChar;   // LPCWSTR optional
  EntryCount: Pointer;   // DWORD* out
  SiteNames: PPWideChar   // LPWSTR** out
): DWORD; stdcall;
  external 'NETAPI32.dll' name 'DsGetDcSiteCoverageW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DsGetDcSiteCoverageW"
  c_DsGetDcSiteCoverageW :: CWString -> Ptr Word32 -> Ptr CWString -> IO Word32
-- ServerName : LPCWSTR optional -> CWString
-- EntryCount : DWORD* out -> Ptr Word32
-- SiteNames : LPWSTR** out -> Ptr CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dsgetdcsitecoveragew =
  foreign "DsGetDcSiteCoverageW"
    ((ptr uint16_t) @-> (ptr uint32_t) @-> (ptr (ptr uint16_t)) @-> returning uint32_t)
(* ServerName : LPCWSTR optional -> (ptr uint16_t) *)
(* EntryCount : DWORD* out -> (ptr uint32_t) *)
(* SiteNames : LPWSTR** 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 ("DsGetDcSiteCoverageW" ds-get-dc-site-coverage-w :convention :stdcall) :uint32
  (server-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (entry-count :pointer)   ; DWORD* out
  (site-names :pointer))   ; LPWSTR** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DsGetDcSiteCoverageW = Win32::API::More->new('NETAPI32',
    'DWORD DsGetDcSiteCoverageW(LPCWSTR ServerName, LPVOID EntryCount, LPVOID SiteNames)');
# my $ret = $DsGetDcSiteCoverageW->Call($ServerName, $EntryCount, $SiteNames);
# ServerName : LPCWSTR optional -> LPCWSTR
# EntryCount : DWORD* out -> LPVOID
# SiteNames : LPWSTR** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い