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

DsReplicaGetInfoW

関数
指定DCのレプリケーション状態情報を取得する。
DLLNTDSAPI.dll呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

// NTDSAPI.dll
#include <windows.h>

DWORD DsReplicaGetInfoW(
    HANDLE hDS,
    DS_REPL_INFO_TYPE InfoType,
    LPCWSTR pszObject,   // optional
    GUID* puuidForSourceDsaObjGuid,   // optional
    void** ppInfo
);

パラメーター

名前型方向説明
hDSHANDLEin操作に用いるディレクトリサービスバインドハンドル。
InfoTypeDS_REPL_INFO_TYPEin取得する複製情報の種類を示すDS_REPL_INFO_TYPE列挙値。
pszObjectLPCWSTRinoptional情報取得の対象オブジェクト(NCのDNなど)。種類により意味が変わる。NULL可。
puuidForSourceDsaObjGuidGUID*inoptional対象を絞る複製元DSAのオブジェクトGUIDへのポインタ。NULL可。
ppInfovoid**out取得した複製情報を受け取るポインタのアドレス。DsReplicaFreeInfoで解放する。

戻り値の型: DWORD

各言語での呼び出し定義

// NTDSAPI.dll
#include <windows.h>

DWORD DsReplicaGetInfoW(
    HANDLE hDS,
    DS_REPL_INFO_TYPE InfoType,
    LPCWSTR pszObject,   // optional
    GUID* puuidForSourceDsaObjGuid,   // optional
    void** ppInfo
);
[DllImport("NTDSAPI.dll", ExactSpelling = true)]
static extern uint DsReplicaGetInfoW(
    IntPtr hDS,   // HANDLE
    int InfoType,   // DS_REPL_INFO_TYPE
    [MarshalAs(UnmanagedType.LPWStr)] string pszObject,   // LPCWSTR optional
    IntPtr puuidForSourceDsaObjGuid,   // GUID* optional
    IntPtr ppInfo   // void** out
);
<DllImport("NTDSAPI.dll", ExactSpelling:=True)>
Public Shared Function DsReplicaGetInfoW(
    hDS As IntPtr,   ' HANDLE
    InfoType As Integer,   ' DS_REPL_INFO_TYPE
    <MarshalAs(UnmanagedType.LPWStr)> pszObject As String,   ' LPCWSTR optional
    puuidForSourceDsaObjGuid As IntPtr,   ' GUID* optional
    ppInfo As IntPtr   ' void** out
) As UInteger
End Function
' hDS : HANDLE
' InfoType : DS_REPL_INFO_TYPE
' pszObject : LPCWSTR optional
' puuidForSourceDsaObjGuid : GUID* optional
' ppInfo : void** out
Declare PtrSafe Function DsReplicaGetInfoW Lib "ntdsapi" ( _
    ByVal hDS As LongPtr, _
    ByVal InfoType As Long, _
    ByVal pszObject As LongPtr, _
    ByVal puuidForSourceDsaObjGuid As LongPtr, _
    ByVal ppInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DsReplicaGetInfoW = ctypes.windll.ntdsapi.DsReplicaGetInfoW
DsReplicaGetInfoW.restype = wintypes.DWORD
DsReplicaGetInfoW.argtypes = [
    wintypes.HANDLE,  # hDS : HANDLE
    ctypes.c_int,  # InfoType : DS_REPL_INFO_TYPE
    wintypes.LPCWSTR,  # pszObject : LPCWSTR optional
    ctypes.c_void_p,  # puuidForSourceDsaObjGuid : GUID* optional
    ctypes.c_void_p,  # ppInfo : void** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NTDSAPI.dll')
DsReplicaGetInfoW = Fiddle::Function.new(
  lib['DsReplicaGetInfoW'],
  [
    Fiddle::TYPE_VOIDP,  # hDS : HANDLE
    Fiddle::TYPE_INT,  # InfoType : DS_REPL_INFO_TYPE
    Fiddle::TYPE_VOIDP,  # pszObject : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # puuidForSourceDsaObjGuid : GUID* optional
    Fiddle::TYPE_VOIDP,  # ppInfo : void** out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "ntdsapi")]
extern "system" {
    fn DsReplicaGetInfoW(
        hDS: *mut core::ffi::c_void,  // HANDLE
        InfoType: i32,  // DS_REPL_INFO_TYPE
        pszObject: *const u16,  // LPCWSTR optional
        puuidForSourceDsaObjGuid: *mut GUID,  // GUID* optional
        ppInfo: *mut *mut ()  // void** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("NTDSAPI.dll")]
public static extern uint DsReplicaGetInfoW(IntPtr hDS, int InfoType, [MarshalAs(UnmanagedType.LPWStr)] string pszObject, IntPtr puuidForSourceDsaObjGuid, IntPtr ppInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NTDSAPI_DsReplicaGetInfoW' -Namespace Win32 -PassThru
# $api::DsReplicaGetInfoW(hDS, InfoType, pszObject, puuidForSourceDsaObjGuid, ppInfo)
#uselib "NTDSAPI.dll"
#func global DsReplicaGetInfoW "DsReplicaGetInfoW" sptr, sptr, sptr, sptr, sptr
; DsReplicaGetInfoW hDS, InfoType, pszObject, varptr(puuidForSourceDsaObjGuid), ppInfo   ; 戻り値は stat
; hDS : HANDLE -> "sptr"
; InfoType : DS_REPL_INFO_TYPE -> "sptr"
; pszObject : LPCWSTR optional -> "sptr"
; puuidForSourceDsaObjGuid : GUID* optional -> "sptr"
; ppInfo : void** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "NTDSAPI.dll"
#cfunc global DsReplicaGetInfoW "DsReplicaGetInfoW" sptr, int, wstr, var, sptr
; res = DsReplicaGetInfoW(hDS, InfoType, pszObject, puuidForSourceDsaObjGuid, ppInfo)
; hDS : HANDLE -> "sptr"
; InfoType : DS_REPL_INFO_TYPE -> "int"
; pszObject : LPCWSTR optional -> "wstr"
; puuidForSourceDsaObjGuid : GUID* optional -> "var"
; ppInfo : void** out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; DWORD DsReplicaGetInfoW(HANDLE hDS, DS_REPL_INFO_TYPE InfoType, LPCWSTR pszObject, GUID* puuidForSourceDsaObjGuid, void** ppInfo)
#uselib "NTDSAPI.dll"
#cfunc global DsReplicaGetInfoW "DsReplicaGetInfoW" intptr, int, wstr, var, intptr
; res = DsReplicaGetInfoW(hDS, InfoType, pszObject, puuidForSourceDsaObjGuid, ppInfo)
; hDS : HANDLE -> "intptr"
; InfoType : DS_REPL_INFO_TYPE -> "int"
; pszObject : LPCWSTR optional -> "wstr"
; puuidForSourceDsaObjGuid : GUID* optional -> "var"
; ppInfo : void** out -> "intptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ntdsapi = windows.NewLazySystemDLL("NTDSAPI.dll")
	procDsReplicaGetInfoW = ntdsapi.NewProc("DsReplicaGetInfoW")
)

// hDS (HANDLE), InfoType (DS_REPL_INFO_TYPE), pszObject (LPCWSTR optional), puuidForSourceDsaObjGuid (GUID* optional), ppInfo (void** out)
r1, _, err := procDsReplicaGetInfoW.Call(
	uintptr(hDS),
	uintptr(InfoType),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(pszObject))),
	uintptr(puuidForSourceDsaObjGuid),
	uintptr(ppInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function DsReplicaGetInfoW(
  hDS: THandle;   // HANDLE
  InfoType: Integer;   // DS_REPL_INFO_TYPE
  pszObject: PWideChar;   // LPCWSTR optional
  puuidForSourceDsaObjGuid: PGUID;   // GUID* optional
  ppInfo: Pointer   // void** out
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsReplicaGetInfoW';
result := DllCall("NTDSAPI\DsReplicaGetInfoW"
    , "Ptr", hDS   ; HANDLE
    , "Int", InfoType   ; DS_REPL_INFO_TYPE
    , "WStr", pszObject   ; LPCWSTR optional
    , "Ptr", puuidForSourceDsaObjGuid   ; GUID* optional
    , "Ptr", ppInfo   ; void** out
    , "UInt")   ; return: DWORD
●DsReplicaGetInfoW(hDS, InfoType, pszObject, puuidForSourceDsaObjGuid, ppInfo) = DLL("NTDSAPI.dll", "dword DsReplicaGetInfoW(void*, int, char*, void*, void*)")
# 呼び出し: DsReplicaGetInfoW(hDS, InfoType, pszObject, puuidForSourceDsaObjGuid, ppInfo)
# hDS : HANDLE -> "void*"
# InfoType : DS_REPL_INFO_TYPE -> "int"
# pszObject : LPCWSTR optional -> "char*"
# puuidForSourceDsaObjGuid : GUID* optional -> "void*"
# ppInfo : void** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "ntdsapi" fn DsReplicaGetInfoW(
    hDS: ?*anyopaque, // HANDLE
    InfoType: i32, // DS_REPL_INFO_TYPE
    pszObject: [*c]const u16, // LPCWSTR optional
    puuidForSourceDsaObjGuid: [*c]GUID, // GUID* optional
    ppInfo: ?*anyopaque // void** out
) callconv(std.os.windows.WINAPI) u32;
proc DsReplicaGetInfoW(
    hDS: pointer,  # HANDLE
    InfoType: int32,  # DS_REPL_INFO_TYPE
    pszObject: WideCString,  # LPCWSTR optional
    puuidForSourceDsaObjGuid: ptr GUID,  # GUID* optional
    ppInfo: pointer  # void** out
): uint32 {.importc: "DsReplicaGetInfoW", stdcall, dynlib: "NTDSAPI.dll".}
pragma(lib, "ntdsapi");
extern(Windows)
uint DsReplicaGetInfoW(
    void* hDS,   // HANDLE
    int InfoType,   // DS_REPL_INFO_TYPE
    const(wchar)* pszObject,   // LPCWSTR optional
    GUID* puuidForSourceDsaObjGuid,   // GUID* optional
    void** ppInfo   // void** out
);
ccall((:DsReplicaGetInfoW, "NTDSAPI.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Int32, Cwstring, Ptr{GUID}, Ptr{Cvoid}),
      hDS, InfoType, pszObject, puuidForSourceDsaObjGuid, ppInfo)
# hDS : HANDLE -> Ptr{Cvoid}
# InfoType : DS_REPL_INFO_TYPE -> Int32
# pszObject : LPCWSTR optional -> Cwstring
# puuidForSourceDsaObjGuid : GUID* optional -> Ptr{GUID}
# ppInfo : void** out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t DsReplicaGetInfoW(
    void* hDS,
    int32_t InfoType,
    const uint16_t* pszObject,
    void* puuidForSourceDsaObjGuid,
    void** ppInfo);
]]
local ntdsapi = ffi.load("ntdsapi")
-- ntdsapi.DsReplicaGetInfoW(hDS, InfoType, pszObject, puuidForSourceDsaObjGuid, ppInfo)
-- hDS : HANDLE
-- InfoType : DS_REPL_INFO_TYPE
-- pszObject : LPCWSTR optional
-- puuidForSourceDsaObjGuid : GUID* optional
-- ppInfo : void** out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NTDSAPI.dll');
const DsReplicaGetInfoW = lib.func('__stdcall', 'DsReplicaGetInfoW', 'uint32_t', ['void *', 'int32_t', 'str16', 'void *', 'void *']);
// DsReplicaGetInfoW(hDS, InfoType, pszObject, puuidForSourceDsaObjGuid, ppInfo)
// hDS : HANDLE -> 'void *'
// InfoType : DS_REPL_INFO_TYPE -> 'int32_t'
// pszObject : LPCWSTR optional -> 'str16'
// puuidForSourceDsaObjGuid : GUID* optional -> 'void *'
// ppInfo : void** out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NTDSAPI.dll", {
  DsReplicaGetInfoW: { parameters: ["pointer", "i32", "buffer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.DsReplicaGetInfoW(hDS, InfoType, pszObject, puuidForSourceDsaObjGuid, ppInfo)
// hDS : HANDLE -> "pointer"
// InfoType : DS_REPL_INFO_TYPE -> "i32"
// pszObject : LPCWSTR optional -> "buffer"
// puuidForSourceDsaObjGuid : GUID* optional -> "pointer"
// ppInfo : void** out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t DsReplicaGetInfoW(
    void* hDS,
    int32_t InfoType,
    const uint16_t* pszObject,
    void* puuidForSourceDsaObjGuid,
    void** ppInfo);
C, "NTDSAPI.dll");
// $ffi->DsReplicaGetInfoW(hDS, InfoType, pszObject, puuidForSourceDsaObjGuid, ppInfo);
// hDS : HANDLE
// InfoType : DS_REPL_INFO_TYPE
// pszObject : LPCWSTR optional
// puuidForSourceDsaObjGuid : GUID* optional
// ppInfo : void** 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);
    int DsReplicaGetInfoW(
        Pointer hDS,   // HANDLE
        int InfoType,   // DS_REPL_INFO_TYPE
        WString pszObject,   // LPCWSTR optional
        Pointer puuidForSourceDsaObjGuid,   // GUID* optional
        Pointer ppInfo   // void** out
    );
}
@[Link("ntdsapi")]
lib LibNTDSAPI
  fun DsReplicaGetInfoW = DsReplicaGetInfoW(
    hDS : Void*,   # HANDLE
    InfoType : Int32,   # DS_REPL_INFO_TYPE
    pszObject : UInt16*,   # LPCWSTR optional
    puuidForSourceDsaObjGuid : GUID*,   # GUID* optional
    ppInfo : Void**   # void** out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DsReplicaGetInfoWNative = Uint32 Function(Pointer<Void>, Int32, Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
typedef DsReplicaGetInfoWDart = int Function(Pointer<Void>, int, Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
final DsReplicaGetInfoW = DynamicLibrary.open('NTDSAPI.dll')
    .lookupFunction<DsReplicaGetInfoWNative, DsReplicaGetInfoWDart>('DsReplicaGetInfoW');
// hDS : HANDLE -> Pointer<Void>
// InfoType : DS_REPL_INFO_TYPE -> Int32
// pszObject : LPCWSTR optional -> Pointer<Utf16>
// puuidForSourceDsaObjGuid : GUID* optional -> Pointer<Void>
// ppInfo : void** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DsReplicaGetInfoW(
  hDS: THandle;   // HANDLE
  InfoType: Integer;   // DS_REPL_INFO_TYPE
  pszObject: PWideChar;   // LPCWSTR optional
  puuidForSourceDsaObjGuid: PGUID;   // GUID* optional
  ppInfo: Pointer   // void** out
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsReplicaGetInfoW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DsReplicaGetInfoW"
  c_DsReplicaGetInfoW :: Ptr () -> Int32 -> CWString -> Ptr () -> Ptr () -> IO Word32
-- hDS : HANDLE -> Ptr ()
-- InfoType : DS_REPL_INFO_TYPE -> Int32
-- pszObject : LPCWSTR optional -> CWString
-- puuidForSourceDsaObjGuid : GUID* optional -> Ptr ()
-- ppInfo : void** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dsreplicagetinfow =
  foreign "DsReplicaGetInfoW"
    ((ptr void) @-> int32_t @-> (ptr uint16_t) @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* hDS : HANDLE -> (ptr void) *)
(* InfoType : DS_REPL_INFO_TYPE -> int32_t *)
(* pszObject : LPCWSTR optional -> (ptr uint16_t) *)
(* puuidForSourceDsaObjGuid : GUID* optional -> (ptr void) *)
(* ppInfo : void** 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 ("DsReplicaGetInfoW" ds-replica-get-info-w :convention :stdcall) :uint32
  (h-ds :pointer)   ; HANDLE
  (info-type :int32)   ; DS_REPL_INFO_TYPE
  (psz-object (:string :encoding :utf-16le))   ; LPCWSTR optional
  (puuid-for-source-dsa-obj-guid :pointer)   ; GUID* optional
  (pp-info :pointer))   ; void** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DsReplicaGetInfoW = Win32::API::More->new('NTDSAPI',
    'DWORD DsReplicaGetInfoW(HANDLE hDS, int InfoType, LPCWSTR pszObject, LPVOID puuidForSourceDsaObjGuid, LPVOID ppInfo)');
# my $ret = $DsReplicaGetInfoW->Call($hDS, $InfoType, $pszObject, $puuidForSourceDsaObjGuid, $ppInfo);
# hDS : HANDLE -> HANDLE
# InfoType : DS_REPL_INFO_TYPE -> int
# pszObject : LPCWSTR optional -> LPCWSTR
# puuidForSourceDsaObjGuid : GUID* optional -> LPVOID
# ppInfo : void** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型