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

DsQuerySitesByCostA

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

シグネチャ

// 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
rgszToSitesLPSTR*in
cToSitesDWORDin
dwFlagsDWORDoptional
prgSiteInfoDS_SITE_COST_INFO**out

戻り値の型: 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)。