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

DsQuerySitesByCostW

関数
起点サイトから複数の対象サイトへのレプリケーションコストを問い合わせる。
DLLNTDSAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// 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
);

パラメーター

名前型方向説明
hDSHANDLEin操作に用いるディレクトリサービスバインドハンドル。
pwszFromSiteLPWSTRinコスト算出の起点となるサイト名(ワイド)。
rgwszToSitesLPWSTR*inコストを求める宛先サイト名の配列へのポインタ。
cToSitesDWORDinrgwszToSites配列の宛先サイト数。
dwFlagsDWORDoptionalクエリ動作を制御するフラグ。通常0を指定する。
prgSiteInfoDS_SITE_COST_INFO**outサイト間コスト情報配列を受け取るポインタのアドレス。DsQuerySitesFreeで解放する。

戻り値の型: 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 方式にも切替可。
出力引数: 
; 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 方式にも切替可。
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 版の利用を推奨。
const std = @import("std");

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

typedef DsQuerySitesByCostWNative = Uint32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Pointer<Utf16>>, Uint32, Uint32, Pointer<Void>);
typedef DsQuerySitesByCostWDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Pointer<Utf16>>, int, int, Pointer<Void>);
final DsQuerySitesByCostW = DynamicLibrary.open('NTDSAPI.dll')
    .lookupFunction<DsQuerySitesByCostWNative, DsQuerySitesByCostWDart>('DsQuerySitesByCostW');
// hDS : HANDLE -> Pointer<Void>
// pwszFromSite : LPWSTR -> Pointer<Utf16>
// rgwszToSites : LPWSTR* -> Pointer<Pointer<Utf16>>
// cToSites : DWORD -> Uint32
// dwFlags : DWORD optional -> Uint32
// prgSiteInfo : DS_SITE_COST_INFO** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DsQuerySitesByCostW"
  c_DsQuerySitesByCostW :: Ptr () -> CWString -> Ptr CWString -> Word32 -> Word32 -> Ptr () -> IO Word32
-- hDS : HANDLE -> Ptr ()
-- pwszFromSite : LPWSTR -> CWString
-- rgwszToSites : LPWSTR* -> Ptr CWString
-- cToSites : DWORD -> Word32
-- dwFlags : DWORD optional -> Word32
-- prgSiteInfo : DS_SITE_COST_INFO** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dsquerysitesbycostw =
  foreign "DsQuerySitesByCostW"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr (ptr uint16_t)) @-> uint32_t @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* hDS : HANDLE -> (ptr void) *)
(* pwszFromSite : LPWSTR -> (ptr uint16_t) *)
(* rgwszToSites : LPWSTR* -> (ptr (ptr uint16_t)) *)
(* cToSites : DWORD -> uint32_t *)
(* dwFlags : DWORD optional -> uint32_t *)
(* prgSiteInfo : DS_SITE_COST_INFO** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ntdsapi (t "NTDSAPI.dll"))
(cffi:use-foreign-library ntdsapi)

(cffi:defcfun ("DsQuerySitesByCostW" ds-query-sites-by-cost-w :convention :stdcall) :uint32
  (h-ds :pointer)   ; HANDLE
  (pwsz-from-site (:string :encoding :utf-16le))   ; LPWSTR
  (rgwsz-to-sites :pointer)   ; LPWSTR*
  (c-to-sites :uint32)   ; DWORD
  (dw-flags :uint32)   ; DWORD optional
  (prg-site-info :pointer))   ; DS_SITE_COST_INFO** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DsQuerySitesByCostW = Win32::API::More->new('NTDSAPI',
    'DWORD DsQuerySitesByCostW(HANDLE hDS, LPCWSTR pwszFromSite, LPVOID rgwszToSites, DWORD cToSites, DWORD dwFlags, LPVOID prgSiteInfo)');
# my $ret = $DsQuerySitesByCostW->Call($hDS, $pwszFromSite, $rgwszToSites, $cToSites, $dwFlags, $prgSiteInfo);
# hDS : HANDLE -> HANDLE
# pwszFromSite : LPWSTR -> LPCWSTR
# rgwszToSites : LPWSTR* -> LPVOID
# cToSites : DWORD -> DWORD
# dwFlags : DWORD optional -> DWORD
# prgSiteInfo : DS_SITE_COST_INFO** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

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