ホーム › Networking.ActiveDirectory › DsQuerySitesByCostW

DsQuerySitesByCostW

関数

起点サイトから複数の対象サイトへのレプリケーションコストを問い合わせる。

DLLNTDSAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD DsQuerySitesByCostW(
    HANDLE hDS,
    LPWSTR pwszFromSite,
    LPWSTR* rgwszToSites,
    DWORD cToSites,
    DWORD dwFlags,   // optional
    DS_SITE_COST_INFO** prgSiteInfo
);

パラメーター

名前	型	方向
hDS	HANDLE	in
pwszFromSite	LPWSTR	in
rgwszToSites	LPWSTR*	in
cToSites	DWORD	in
dwFlags	DWORD	optional
prgSiteInfo	DS_SITE_COST_INFO**	out

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DsQuerySitesByCostW(
    HANDLE hDS,
    LPWSTR pwszFromSite,
    LPWSTR* rgwszToSites,
    DWORD cToSites,
    DWORD dwFlags,   // optional
    DS_SITE_COST_INFO** prgSiteInfo
);

[DllImport("NTDSAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint DsQuerySitesByCostW(
    IntPtr hDS,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string pwszFromSite,   // LPWSTR
    IntPtr rgwszToSites,   // LPWSTR*
    uint cToSites,   // DWORD
    uint dwFlags,   // DWORD optional
    IntPtr prgSiteInfo   // DS_SITE_COST_INFO** out
);

<DllImport("NTDSAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function DsQuerySitesByCostW(
    hDS As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> pwszFromSite As String,   ' LPWSTR
    rgwszToSites As IntPtr,   ' LPWSTR*
    cToSites As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD optional
    prgSiteInfo As IntPtr   ' DS_SITE_COST_INFO** out
) As UInteger
End Function

' hDS : HANDLE
' pwszFromSite : LPWSTR
' rgwszToSites : LPWSTR*
' cToSites : DWORD
' dwFlags : DWORD optional
' prgSiteInfo : DS_SITE_COST_INFO** out
Declare PtrSafe Function DsQuerySitesByCostW Lib "ntdsapi" ( _
    ByVal hDS As LongPtr, _
    ByVal pwszFromSite As LongPtr, _
    ByVal rgwszToSites As LongPtr, _
    ByVal cToSites As Long, _
    ByVal dwFlags As Long, _
    ByVal prgSiteInfo 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

DsQuerySitesByCostW = ctypes.windll.ntdsapi.DsQuerySitesByCostW
DsQuerySitesByCostW.restype = wintypes.DWORD
DsQuerySitesByCostW.argtypes = [
    wintypes.HANDLE,  # hDS : HANDLE
    wintypes.LPCWSTR,  # pwszFromSite : LPWSTR
    ctypes.c_void_p,  # rgwszToSites : LPWSTR*
    wintypes.DWORD,  # cToSites : DWORD
    wintypes.DWORD,  # dwFlags : DWORD optional
    ctypes.c_void_p,  # prgSiteInfo : DS_SITE_COST_INFO** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NTDSAPI.dll')
DsQuerySitesByCostW = Fiddle::Function.new(
  lib['DsQuerySitesByCostW'],
  [
    Fiddle::TYPE_VOIDP,  # hDS : HANDLE
    Fiddle::TYPE_VOIDP,  # pwszFromSite : LPWSTR
    Fiddle::TYPE_VOIDP,  # rgwszToSites : LPWSTR*
    -Fiddle::TYPE_INT,  # cToSites : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD optional
    Fiddle::TYPE_VOIDP,  # prgSiteInfo : DS_SITE_COST_INFO** out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "ntdsapi")]
extern "system" {
    fn DsQuerySitesByCostW(
        hDS: *mut core::ffi::c_void,  // HANDLE
        pwszFromSite: *mut u16,  // LPWSTR
        rgwszToSites: *mut *mut u16,  // LPWSTR*
        cToSites: u32,  // DWORD
        dwFlags: u32,  // DWORD optional
        prgSiteInfo: *mut *mut DS_SITE_COST_INFO  // DS_SITE_COST_INFO** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("NTDSAPI.dll", CharSet = CharSet.Unicode)]
public static extern uint DsQuerySitesByCostW(IntPtr hDS, [MarshalAs(UnmanagedType.LPWStr)] string pwszFromSite, IntPtr rgwszToSites, uint cToSites, uint dwFlags, IntPtr prgSiteInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NTDSAPI_DsQuerySitesByCostW' -Namespace Win32 -PassThru
# $api::DsQuerySitesByCostW(hDS, pwszFromSite, rgwszToSites, cToSites, dwFlags, prgSiteInfo)

#uselib "NTDSAPI.dll"
#func global DsQuerySitesByCostW "DsQuerySitesByCostW" wptr, wptr, wptr, wptr, wptr, wptr
; DsQuerySitesByCostW hDS, pwszFromSite, varptr(rgwszToSites), cToSites, dwFlags, varptr(prgSiteInfo)   ; 戻り値は stat
; hDS : HANDLE -> "wptr"
; pwszFromSite : LPWSTR -> "wptr"
; rgwszToSites : LPWSTR* -> "wptr"
; cToSites : DWORD -> "wptr"
; dwFlags : DWORD optional -> "wptr"
; prgSiteInfo : DS_SITE_COST_INFO** out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "NTDSAPI.dll"
#cfunc global DsQuerySitesByCostW "DsQuerySitesByCostW" sptr, wstr, var, int, int, var
; res = DsQuerySitesByCostW(hDS, pwszFromSite, rgwszToSites, cToSites, dwFlags, prgSiteInfo)
; hDS : HANDLE -> "sptr"
; pwszFromSite : LPWSTR -> "wstr"
; rgwszToSites : LPWSTR* -> "var"
; cToSites : DWORD -> "int"
; dwFlags : DWORD optional -> "int"
; prgSiteInfo : DS_SITE_COST_INFO** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "NTDSAPI.dll"
#cfunc global DsQuerySitesByCostW "DsQuerySitesByCostW" sptr, wstr, sptr, int, int, sptr
; res = DsQuerySitesByCostW(hDS, pwszFromSite, varptr(rgwszToSites), cToSites, dwFlags, varptr(prgSiteInfo))
; hDS : HANDLE -> "sptr"
; pwszFromSite : LPWSTR -> "wstr"
; rgwszToSites : LPWSTR* -> "sptr"
; cToSites : DWORD -> "int"
; dwFlags : DWORD optional -> "int"
; prgSiteInfo : DS_SITE_COST_INFO** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; DWORD DsQuerySitesByCostW(HANDLE hDS, LPWSTR pwszFromSite, LPWSTR* rgwszToSites, DWORD cToSites, DWORD dwFlags, DS_SITE_COST_INFO** prgSiteInfo)
#uselib "NTDSAPI.dll"
#cfunc global DsQuerySitesByCostW "DsQuerySitesByCostW" intptr, wstr, var, int, int, var
; res = DsQuerySitesByCostW(hDS, pwszFromSite, rgwszToSites, cToSites, dwFlags, prgSiteInfo)
; hDS : HANDLE -> "intptr"
; pwszFromSite : LPWSTR -> "wstr"
; rgwszToSites : LPWSTR* -> "var"
; cToSites : DWORD -> "int"
; dwFlags : DWORD optional -> "int"
; prgSiteInfo : DS_SITE_COST_INFO** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD DsQuerySitesByCostW(HANDLE hDS, LPWSTR pwszFromSite, LPWSTR* rgwszToSites, DWORD cToSites, DWORD dwFlags, DS_SITE_COST_INFO** prgSiteInfo)
#uselib "NTDSAPI.dll"
#cfunc global DsQuerySitesByCostW "DsQuerySitesByCostW" intptr, wstr, intptr, int, int, intptr
; res = DsQuerySitesByCostW(hDS, pwszFromSite, varptr(rgwszToSites), cToSites, dwFlags, varptr(prgSiteInfo))
; hDS : HANDLE -> "intptr"
; pwszFromSite : LPWSTR -> "wstr"
; rgwszToSites : LPWSTR* -> "intptr"
; cToSites : DWORD -> "int"
; dwFlags : DWORD optional -> "int"
; prgSiteInfo : DS_SITE_COST_INFO** out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ntdsapi = windows.NewLazySystemDLL("NTDSAPI.dll")
	procDsQuerySitesByCostW = ntdsapi.NewProc("DsQuerySitesByCostW")
)

// hDS (HANDLE), pwszFromSite (LPWSTR), rgwszToSites (LPWSTR*), cToSites (DWORD), dwFlags (DWORD optional), prgSiteInfo (DS_SITE_COST_INFO** out)
r1, _, err := procDsQuerySitesByCostW.Call(
	uintptr(hDS),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pwszFromSite))),
	uintptr(rgwszToSites),
	uintptr(cToSites),
	uintptr(dwFlags),
	uintptr(prgSiteInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function DsQuerySitesByCostW(
  hDS: THandle;   // HANDLE
  pwszFromSite: PWideChar;   // LPWSTR
  rgwszToSites: PPWideChar;   // LPWSTR*
  cToSites: DWORD;   // DWORD
  dwFlags: DWORD;   // DWORD optional
  prgSiteInfo: Pointer   // DS_SITE_COST_INFO** out
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsQuerySitesByCostW';

result := DllCall("NTDSAPI\DsQuerySitesByCostW"
    , "Ptr", hDS   ; HANDLE
    , "WStr", pwszFromSite   ; LPWSTR
    , "Ptr", rgwszToSites   ; LPWSTR*
    , "UInt", cToSites   ; DWORD
    , "UInt", dwFlags   ; DWORD optional
    , "Ptr", prgSiteInfo   ; DS_SITE_COST_INFO** out
    , "UInt")   ; return: DWORD

●DsQuerySitesByCostW(hDS, pwszFromSite, rgwszToSites, cToSites, dwFlags, prgSiteInfo) = DLL("NTDSAPI.dll", "dword DsQuerySitesByCostW(void*, char*, void*, dword, dword, void*)")
# 呼び出し: DsQuerySitesByCostW(hDS, pwszFromSite, rgwszToSites, cToSites, dwFlags, prgSiteInfo)
# hDS : HANDLE -> "void*"
# pwszFromSite : LPWSTR -> "char*"
# rgwszToSites : LPWSTR* -> "void*"
# cToSites : DWORD -> "dword"
# dwFlags : DWORD optional -> "dword"
# prgSiteInfo : DS_SITE_COST_INFO** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。