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

DsReplicaConsistencyCheck

関数
KCCにレプリケーショントポロジの整合性チェックを実行させる。
DLLNTDSAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD DsReplicaConsistencyCheck(
    HANDLE hDS,
    DS_KCC_TASKID TaskID,
    DWORD dwFlags
);

パラメーター

名前方向説明
hDSHANDLEin操作に用いるディレクトリサービスバインドハンドル。
TaskIDDS_KCC_TASKIDin実行するKCCタスクを示すDS_KCC_TASKID列挙値。
dwFlagsDWORDin整合性チェック動作を制御するDS_KCC_FLAG_*フラグ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DsReplicaConsistencyCheck(
    HANDLE hDS,
    DS_KCC_TASKID TaskID,
    DWORD dwFlags
);
[DllImport("NTDSAPI.dll", ExactSpelling = true)]
static extern uint DsReplicaConsistencyCheck(
    IntPtr hDS,   // HANDLE
    int TaskID,   // DS_KCC_TASKID
    uint dwFlags   // DWORD
);
<DllImport("NTDSAPI.dll", ExactSpelling:=True)>
Public Shared Function DsReplicaConsistencyCheck(
    hDS As IntPtr,   ' HANDLE
    TaskID As Integer,   ' DS_KCC_TASKID
    dwFlags As UInteger   ' DWORD
) As UInteger
End Function
' hDS : HANDLE
' TaskID : DS_KCC_TASKID
' dwFlags : DWORD
Declare PtrSafe Function DsReplicaConsistencyCheck Lib "ntdsapi" ( _
    ByVal hDS As LongPtr, _
    ByVal TaskID As Long, _
    ByVal dwFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DsReplicaConsistencyCheck = ctypes.windll.ntdsapi.DsReplicaConsistencyCheck
DsReplicaConsistencyCheck.restype = wintypes.DWORD
DsReplicaConsistencyCheck.argtypes = [
    wintypes.HANDLE,  # hDS : HANDLE
    ctypes.c_int,  # TaskID : DS_KCC_TASKID
    wintypes.DWORD,  # dwFlags : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NTDSAPI.dll')
DsReplicaConsistencyCheck = Fiddle::Function.new(
  lib['DsReplicaConsistencyCheck'],
  [
    Fiddle::TYPE_VOIDP,  # hDS : HANDLE
    Fiddle::TYPE_INT,  # TaskID : DS_KCC_TASKID
    -Fiddle::TYPE_INT,  # dwFlags : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "ntdsapi")]
extern "system" {
    fn DsReplicaConsistencyCheck(
        hDS: *mut core::ffi::c_void,  // HANDLE
        TaskID: i32,  // DS_KCC_TASKID
        dwFlags: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("NTDSAPI.dll")]
public static extern uint DsReplicaConsistencyCheck(IntPtr hDS, int TaskID, uint dwFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NTDSAPI_DsReplicaConsistencyCheck' -Namespace Win32 -PassThru
# $api::DsReplicaConsistencyCheck(hDS, TaskID, dwFlags)
#uselib "NTDSAPI.dll"
#func global DsReplicaConsistencyCheck "DsReplicaConsistencyCheck" sptr, sptr, sptr
; DsReplicaConsistencyCheck hDS, TaskID, dwFlags   ; 戻り値は stat
; hDS : HANDLE -> "sptr"
; TaskID : DS_KCC_TASKID -> "sptr"
; dwFlags : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "NTDSAPI.dll"
#cfunc global DsReplicaConsistencyCheck "DsReplicaConsistencyCheck" sptr, int, int
; res = DsReplicaConsistencyCheck(hDS, TaskID, dwFlags)
; hDS : HANDLE -> "sptr"
; TaskID : DS_KCC_TASKID -> "int"
; dwFlags : DWORD -> "int"
; DWORD DsReplicaConsistencyCheck(HANDLE hDS, DS_KCC_TASKID TaskID, DWORD dwFlags)
#uselib "NTDSAPI.dll"
#cfunc global DsReplicaConsistencyCheck "DsReplicaConsistencyCheck" intptr, int, int
; res = DsReplicaConsistencyCheck(hDS, TaskID, dwFlags)
; hDS : HANDLE -> "intptr"
; TaskID : DS_KCC_TASKID -> "int"
; dwFlags : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ntdsapi = windows.NewLazySystemDLL("NTDSAPI.dll")
	procDsReplicaConsistencyCheck = ntdsapi.NewProc("DsReplicaConsistencyCheck")
)

// hDS (HANDLE), TaskID (DS_KCC_TASKID), dwFlags (DWORD)
r1, _, err := procDsReplicaConsistencyCheck.Call(
	uintptr(hDS),
	uintptr(TaskID),
	uintptr(dwFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function DsReplicaConsistencyCheck(
  hDS: THandle;   // HANDLE
  TaskID: Integer;   // DS_KCC_TASKID
  dwFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsReplicaConsistencyCheck';
result := DllCall("NTDSAPI\DsReplicaConsistencyCheck"
    , "Ptr", hDS   ; HANDLE
    , "Int", TaskID   ; DS_KCC_TASKID
    , "UInt", dwFlags   ; DWORD
    , "UInt")   ; return: DWORD
●DsReplicaConsistencyCheck(hDS, TaskID, dwFlags) = DLL("NTDSAPI.dll", "dword DsReplicaConsistencyCheck(void*, int, dword)")
# 呼び出し: DsReplicaConsistencyCheck(hDS, TaskID, dwFlags)
# hDS : HANDLE -> "void*"
# TaskID : DS_KCC_TASKID -> "int"
# dwFlags : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef DsReplicaConsistencyCheckNative = Uint32 Function(Pointer<Void>, Int32, Uint32);
typedef DsReplicaConsistencyCheckDart = int Function(Pointer<Void>, int, int);
final DsReplicaConsistencyCheck = DynamicLibrary.open('NTDSAPI.dll')
    .lookupFunction<DsReplicaConsistencyCheckNative, DsReplicaConsistencyCheckDart>('DsReplicaConsistencyCheck');
// hDS : HANDLE -> Pointer<Void>
// TaskID : DS_KCC_TASKID -> Int32
// dwFlags : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DsReplicaConsistencyCheck(
  hDS: THandle;   // HANDLE
  TaskID: Integer;   // DS_KCC_TASKID
  dwFlags: DWORD   // DWORD
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsReplicaConsistencyCheck';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DsReplicaConsistencyCheck"
  c_DsReplicaConsistencyCheck :: Ptr () -> Int32 -> Word32 -> IO Word32
-- hDS : HANDLE -> Ptr ()
-- TaskID : DS_KCC_TASKID -> Int32
-- dwFlags : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dsreplicaconsistencycheck =
  foreign "DsReplicaConsistencyCheck"
    ((ptr void) @-> int32_t @-> uint32_t @-> returning uint32_t)
(* hDS : HANDLE -> (ptr void) *)
(* TaskID : DS_KCC_TASKID -> int32_t *)
(* dwFlags : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ntdsapi (t "NTDSAPI.dll"))
(cffi:use-foreign-library ntdsapi)

(cffi:defcfun ("DsReplicaConsistencyCheck" ds-replica-consistency-check :convention :stdcall) :uint32
  (h-ds :pointer)   ; HANDLE
  (task-id :int32)   ; DS_KCC_TASKID
  (dw-flags :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DsReplicaConsistencyCheck = Win32::API::More->new('NTDSAPI',
    'DWORD DsReplicaConsistencyCheck(HANDLE hDS, int TaskID, DWORD dwFlags)');
# my $ret = $DsReplicaConsistencyCheck->Call($hDS, $TaskID, $dwFlags);
# hDS : HANDLE -> HANDLE
# TaskID : DS_KCC_TASKID -> int
# dwFlags : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型