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

DsQuerySitesByCostA

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

シグネチャ

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

DWORD DsQuerySitesByCostA(
    HANDLE hDS,
    LPSTR pszFromSite,
    LPSTR* rgszToSites,
    DWORD cToSites,
    DWORD dwFlags,   // optional
    DS_SITE_COST_INFO** prgSiteInfo
);

パラメーター

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

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DsQuerySitesByCostA(
    HANDLE hDS,
    LPSTR pszFromSite,
    LPSTR* rgszToSites,
    DWORD cToSites,
    DWORD dwFlags,   // optional
    DS_SITE_COST_INFO** prgSiteInfo
);
[DllImport("NTDSAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint DsQuerySitesByCostA(
    IntPtr hDS,   // HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string pszFromSite,   // LPSTR
    IntPtr rgszToSites,   // LPSTR*
    uint cToSites,   // DWORD
    uint dwFlags,   // DWORD optional
    IntPtr prgSiteInfo   // DS_SITE_COST_INFO** out
);
<DllImport("NTDSAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function DsQuerySitesByCostA(
    hDS As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPStr)> pszFromSite As String,   ' LPSTR
    rgszToSites As IntPtr,   ' LPSTR*
    cToSites As UInteger,   ' DWORD
    dwFlags As UInteger,   ' DWORD optional
    prgSiteInfo As IntPtr   ' DS_SITE_COST_INFO** out
) As UInteger
End Function
' hDS : HANDLE
' pszFromSite : LPSTR
' rgszToSites : LPSTR*
' cToSites : DWORD
' dwFlags : DWORD optional
' prgSiteInfo : DS_SITE_COST_INFO** out
Declare PtrSafe Function DsQuerySitesByCostA Lib "ntdsapi" ( _
    ByVal hDS As LongPtr, _
    ByVal pszFromSite As String, _
    ByVal rgszToSites As LongPtr, _
    ByVal cToSites As Long, _
    ByVal dwFlags As Long, _
    ByVal prgSiteInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DsQuerySitesByCostA = ctypes.windll.ntdsapi.DsQuerySitesByCostA
DsQuerySitesByCostA.restype = wintypes.DWORD
DsQuerySitesByCostA.argtypes = [
    wintypes.HANDLE,  # hDS : HANDLE
    wintypes.LPCSTR,  # pszFromSite : LPSTR
    ctypes.c_void_p,  # rgszToSites : LPSTR*
    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')
DsQuerySitesByCostA = Fiddle::Function.new(
  lib['DsQuerySitesByCostA'],
  [
    Fiddle::TYPE_VOIDP,  # hDS : HANDLE
    Fiddle::TYPE_VOIDP,  # pszFromSite : LPSTR
    Fiddle::TYPE_VOIDP,  # rgszToSites : LPSTR*
    -Fiddle::TYPE_INT,  # cToSites : DWORD
    -Fiddle::TYPE_INT,  # dwFlags : DWORD optional
    Fiddle::TYPE_VOIDP,  # prgSiteInfo : DS_SITE_COST_INFO** out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "ntdsapi")]
extern "system" {
    fn DsQuerySitesByCostA(
        hDS: *mut core::ffi::c_void,  // HANDLE
        pszFromSite: *mut u8,  // LPSTR
        rgszToSites: *mut *mut u8,  // LPSTR*
        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.Ansi)]
public static extern uint DsQuerySitesByCostA(IntPtr hDS, [MarshalAs(UnmanagedType.LPStr)] string pszFromSite, IntPtr rgszToSites, uint cToSites, uint dwFlags, IntPtr prgSiteInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NTDSAPI_DsQuerySitesByCostA' -Namespace Win32 -PassThru
# $api::DsQuerySitesByCostA(hDS, pszFromSite, rgszToSites, cToSites, dwFlags, prgSiteInfo)
#uselib "NTDSAPI.dll"
#func global DsQuerySitesByCostA "DsQuerySitesByCostA" sptr, sptr, sptr, sptr, sptr, sptr
; DsQuerySitesByCostA hDS, pszFromSite, varptr(rgszToSites), cToSites, dwFlags, varptr(prgSiteInfo)   ; 戻り値は stat
; hDS : HANDLE -> "sptr"
; pszFromSite : LPSTR -> "sptr"
; rgszToSites : LPSTR* -> "sptr"
; cToSites : DWORD -> "sptr"
; dwFlags : DWORD optional -> "sptr"
; prgSiteInfo : DS_SITE_COST_INFO** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "NTDSAPI.dll"
#cfunc global DsQuerySitesByCostA "DsQuerySitesByCostA" sptr, str, var, int, int, var
; res = DsQuerySitesByCostA(hDS, pszFromSite, rgszToSites, cToSites, dwFlags, prgSiteInfo)
; hDS : HANDLE -> "sptr"
; pszFromSite : LPSTR -> "str"
; rgszToSites : LPSTR* -> "var"
; cToSites : DWORD -> "int"
; dwFlags : DWORD optional -> "int"
; prgSiteInfo : DS_SITE_COST_INFO** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; DWORD DsQuerySitesByCostA(HANDLE hDS, LPSTR pszFromSite, LPSTR* rgszToSites, DWORD cToSites, DWORD dwFlags, DS_SITE_COST_INFO** prgSiteInfo)
#uselib "NTDSAPI.dll"
#cfunc global DsQuerySitesByCostA "DsQuerySitesByCostA" intptr, str, var, int, int, var
; res = DsQuerySitesByCostA(hDS, pszFromSite, rgszToSites, cToSites, dwFlags, prgSiteInfo)
; hDS : HANDLE -> "intptr"
; pszFromSite : LPSTR -> "str"
; rgszToSites : LPSTR* -> "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")
	procDsQuerySitesByCostA = ntdsapi.NewProc("DsQuerySitesByCostA")
)

// hDS (HANDLE), pszFromSite (LPSTR), rgszToSites (LPSTR*), cToSites (DWORD), dwFlags (DWORD optional), prgSiteInfo (DS_SITE_COST_INFO** out)
r1, _, err := procDsQuerySitesByCostA.Call(
	uintptr(hDS),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(pszFromSite))),
	uintptr(rgszToSites),
	uintptr(cToSites),
	uintptr(dwFlags),
	uintptr(prgSiteInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function DsQuerySitesByCostA(
  hDS: THandle;   // HANDLE
  pszFromSite: PAnsiChar;   // LPSTR
  rgszToSites: PPAnsiChar;   // LPSTR*
  cToSites: DWORD;   // DWORD
  dwFlags: DWORD;   // DWORD optional
  prgSiteInfo: Pointer   // DS_SITE_COST_INFO** out
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsQuerySitesByCostA';
result := DllCall("NTDSAPI\DsQuerySitesByCostA"
    , "Ptr", hDS   ; HANDLE
    , "AStr", pszFromSite   ; LPSTR
    , "Ptr", rgszToSites   ; LPSTR*
    , "UInt", cToSites   ; DWORD
    , "UInt", dwFlags   ; DWORD optional
    , "Ptr", prgSiteInfo   ; DS_SITE_COST_INFO** out
    , "UInt")   ; return: DWORD
●DsQuerySitesByCostA(hDS, pszFromSite, rgszToSites, cToSites, dwFlags, prgSiteInfo) = DLL("NTDSAPI.dll", "dword DsQuerySitesByCostA(void*, char*, void*, dword, dword, void*)")
# 呼び出し: DsQuerySitesByCostA(hDS, pszFromSite, rgszToSites, cToSites, dwFlags, prgSiteInfo)
# hDS : HANDLE -> "void*"
# pszFromSite : LPSTR -> "char*"
# rgszToSites : LPSTR* -> "void*"
# cToSites : DWORD -> "dword"
# dwFlags : DWORD optional -> "dword"
# prgSiteInfo : DS_SITE_COST_INFO** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ntdsapi" fn DsQuerySitesByCostA(
    hDS: ?*anyopaque, // HANDLE
    pszFromSite: [*c]const u8, // LPSTR
    rgszToSites: [*c][*c]u8, // LPSTR*
    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;
proc DsQuerySitesByCostA(
    hDS: pointer,  # HANDLE
    pszFromSite: cstring,  # LPSTR
    rgszToSites: ptr cstring,  # LPSTR*
    cToSites: uint32,  # DWORD
    dwFlags: uint32,  # DWORD optional
    prgSiteInfo: ptr DS_SITE_COST_INFO  # DS_SITE_COST_INFO** out
): uint32 {.importc: "DsQuerySitesByCostA", stdcall, dynlib: "NTDSAPI.dll".}
pragma(lib, "ntdsapi");
extern(Windows)
uint DsQuerySitesByCostA(
    void* hDS,   // HANDLE
    const(char)* pszFromSite,   // LPSTR
    char** rgszToSites,   // LPSTR*
    uint cToSites,   // DWORD
    uint dwFlags,   // DWORD optional
    DS_SITE_COST_INFO** prgSiteInfo   // DS_SITE_COST_INFO** out
);
ccall((:DsQuerySitesByCostA, "NTDSAPI.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cstring, Ptr{Ptr{UInt8}}, UInt32, UInt32, Ptr{DS_SITE_COST_INFO}),
      hDS, pszFromSite, rgszToSites, cToSites, dwFlags, prgSiteInfo)
# hDS : HANDLE -> Ptr{Cvoid}
# pszFromSite : LPSTR -> Cstring
# rgszToSites : LPSTR* -> Ptr{Ptr{UInt8}}
# cToSites : DWORD -> UInt32
# dwFlags : DWORD optional -> UInt32
# prgSiteInfo : DS_SITE_COST_INFO** out -> Ptr{DS_SITE_COST_INFO}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t DsQuerySitesByCostA(
    void* hDS,
    const char* pszFromSite,
    char** rgszToSites,
    uint32_t cToSites,
    uint32_t dwFlags,
    void* prgSiteInfo);
]]
local ntdsapi = ffi.load("ntdsapi")
-- ntdsapi.DsQuerySitesByCostA(hDS, pszFromSite, rgszToSites, cToSites, dwFlags, prgSiteInfo)
-- hDS : HANDLE
-- pszFromSite : LPSTR
-- rgszToSites : LPSTR*
-- cToSites : DWORD
-- dwFlags : DWORD optional
-- prgSiteInfo : DS_SITE_COST_INFO** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NTDSAPI.dll');
const DsQuerySitesByCostA = lib.func('__stdcall', 'DsQuerySitesByCostA', 'uint32_t', ['void *', 'str', 'void *', 'uint32_t', 'uint32_t', 'void *']);
// DsQuerySitesByCostA(hDS, pszFromSite, rgszToSites, cToSites, dwFlags, prgSiteInfo)
// hDS : HANDLE -> 'void *'
// pszFromSite : LPSTR -> 'str'
// rgszToSites : LPSTR* -> '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", {
  DsQuerySitesByCostA: { parameters: ["pointer", "buffer", "pointer", "u32", "u32", "pointer"], result: "u32" },
});
// lib.symbols.DsQuerySitesByCostA(hDS, pszFromSite, rgszToSites, cToSites, dwFlags, prgSiteInfo)
// hDS : HANDLE -> "pointer"
// pszFromSite : LPSTR -> "buffer"
// rgszToSites : LPSTR* -> "pointer"
// cToSites : DWORD -> "u32"
// dwFlags : DWORD optional -> "u32"
// prgSiteInfo : DS_SITE_COST_INFO** out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t DsQuerySitesByCostA(
    void* hDS,
    const char* pszFromSite,
    char** rgszToSites,
    uint32_t cToSites,
    uint32_t dwFlags,
    void* prgSiteInfo);
C, "NTDSAPI.dll");
// $ffi->DsQuerySitesByCostA(hDS, pszFromSite, rgszToSites, cToSites, dwFlags, prgSiteInfo);
// hDS : HANDLE
// pszFromSite : LPSTR
// rgszToSites : LPSTR*
// 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.ASCII_OPTIONS);
    int DsQuerySitesByCostA(
        Pointer hDS,   // HANDLE
        String pszFromSite,   // LPSTR
        PointerByReference rgszToSites,   // LPSTR*
        int cToSites,   // DWORD
        int dwFlags,   // DWORD optional
        Pointer prgSiteInfo   // DS_SITE_COST_INFO** out
    );
}
@[Link("ntdsapi")]
lib LibNTDSAPI
  fun DsQuerySitesByCostA = DsQuerySitesByCostA(
    hDS : Void*,   # HANDLE
    pszFromSite : UInt8*,   # LPSTR
    rgszToSites : UInt8**,   # LPSTR*
    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 DsQuerySitesByCostANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Pointer<Utf8>>, Uint32, Uint32, Pointer<Void>);
typedef DsQuerySitesByCostADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Pointer<Utf8>>, int, int, Pointer<Void>);
final DsQuerySitesByCostA = DynamicLibrary.open('NTDSAPI.dll')
    .lookupFunction<DsQuerySitesByCostANative, DsQuerySitesByCostADart>('DsQuerySitesByCostA');
// hDS : HANDLE -> Pointer<Void>
// pszFromSite : LPSTR -> Pointer<Utf8>
// rgszToSites : LPSTR* -> Pointer<Pointer<Utf8>>
// cToSites : DWORD -> Uint32
// dwFlags : DWORD optional -> Uint32
// prgSiteInfo : DS_SITE_COST_INFO** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DsQuerySitesByCostA(
  hDS: THandle;   // HANDLE
  pszFromSite: PAnsiChar;   // LPSTR
  rgszToSites: PPAnsiChar;   // LPSTR*
  cToSites: DWORD;   // DWORD
  dwFlags: DWORD;   // DWORD optional
  prgSiteInfo: Pointer   // DS_SITE_COST_INFO** out
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsQuerySitesByCostA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DsQuerySitesByCostA"
  c_DsQuerySitesByCostA :: Ptr () -> CString -> Ptr CString -> Word32 -> Word32 -> Ptr () -> IO Word32
-- hDS : HANDLE -> Ptr ()
-- pszFromSite : LPSTR -> CString
-- rgszToSites : LPSTR* -> Ptr CString
-- 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 dsquerysitesbycosta =
  foreign "DsQuerySitesByCostA"
    ((ptr void) @-> string @-> (ptr string) @-> uint32_t @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* hDS : HANDLE -> (ptr void) *)
(* pszFromSite : LPSTR -> string *)
(* rgszToSites : LPSTR* -> (ptr string) *)
(* 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 ("DsQuerySitesByCostA" ds-query-sites-by-cost-a :convention :stdcall) :uint32
  (h-ds :pointer)   ; HANDLE
  (psz-from-site :string)   ; LPSTR
  (rgsz-to-sites :pointer)   ; LPSTR*
  (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 $DsQuerySitesByCostA = Win32::API::More->new('NTDSAPI',
    'DWORD DsQuerySitesByCostA(HANDLE hDS, LPCSTR pszFromSite, LPVOID rgszToSites, DWORD cToSites, DWORD dwFlags, LPVOID prgSiteInfo)');
# my $ret = $DsQuerySitesByCostA->Call($hDS, $pszFromSite, $rgszToSites, $cToSites, $dwFlags, $prgSiteInfo);
# hDS : HANDLE -> HANDLE
# pszFromSite : LPSTR -> LPCSTR
# rgszToSites : LPSTR* -> LPVOID
# cToSites : DWORD -> DWORD
# dwFlags : DWORD optional -> DWORD
# prgSiteInfo : DS_SITE_COST_INFO** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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