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

DsReplicaSyncAllA

関数
ネーミングコンテキスト全体の複製を一括同期する(ANSI版)。
DLLNTDSAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD DsReplicaSyncAllA(
    HANDLE hDS,
    LPCSTR pszNameContext,
    DWORD ulFlags,
    INT_PTR pFnCallBack,
    void* pCallbackData,   // optional
    DS_REPSYNCALL_ERRINFOA*** pErrors   // optional
);

パラメーター

名前方向説明
hDSHANDLEin操作に用いるディレクトリサービスバインドハンドル。
pszNameContextLPCSTRin全DSA間で同期する名前付けコンテキストのDN(ANSI)。
ulFlagsDWORDin同期動作を制御するDS_REPSYNCALL_*フラグ。
pFnCallBackINT_PTRin進行状況やエラーを受け取るコールバック関数へのポインタ。NULL可。
pCallbackDatavoid*inoptionalコールバックに渡す任意データへのポインタ。NULL可。
pErrorsDS_REPSYNCALL_ERRINFOA***outoptional発生したエラー情報配列を受け取るポインタのアドレス。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DsReplicaSyncAllA(
    HANDLE hDS,
    LPCSTR pszNameContext,
    DWORD ulFlags,
    INT_PTR pFnCallBack,
    void* pCallbackData,   // optional
    DS_REPSYNCALL_ERRINFOA*** pErrors   // optional
);
[DllImport("NTDSAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint DsReplicaSyncAllA(
    IntPtr hDS,   // HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string pszNameContext,   // LPCSTR
    uint ulFlags,   // DWORD
    IntPtr pFnCallBack,   // INT_PTR
    IntPtr pCallbackData,   // void* optional
    IntPtr pErrors   // DS_REPSYNCALL_ERRINFOA*** optional, out
);
<DllImport("NTDSAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function DsReplicaSyncAllA(
    hDS As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPStr)> pszNameContext As String,   ' LPCSTR
    ulFlags As UInteger,   ' DWORD
    pFnCallBack As IntPtr,   ' INT_PTR
    pCallbackData As IntPtr,   ' void* optional
    pErrors As IntPtr   ' DS_REPSYNCALL_ERRINFOA*** optional, out
) As UInteger
End Function
' hDS : HANDLE
' pszNameContext : LPCSTR
' ulFlags : DWORD
' pFnCallBack : INT_PTR
' pCallbackData : void* optional
' pErrors : DS_REPSYNCALL_ERRINFOA*** optional, out
Declare PtrSafe Function DsReplicaSyncAllA Lib "ntdsapi" ( _
    ByVal hDS As LongPtr, _
    ByVal pszNameContext As String, _
    ByVal ulFlags As Long, _
    ByVal pFnCallBack As LongPtr, _
    ByVal pCallbackData As LongPtr, _
    ByVal pErrors As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DsReplicaSyncAllA = ctypes.windll.ntdsapi.DsReplicaSyncAllA
DsReplicaSyncAllA.restype = wintypes.DWORD
DsReplicaSyncAllA.argtypes = [
    wintypes.HANDLE,  # hDS : HANDLE
    wintypes.LPCSTR,  # pszNameContext : LPCSTR
    wintypes.DWORD,  # ulFlags : DWORD
    ctypes.c_ssize_t,  # pFnCallBack : INT_PTR
    ctypes.POINTER(None),  # pCallbackData : void* optional
    ctypes.c_void_p,  # pErrors : DS_REPSYNCALL_ERRINFOA*** optional, out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ntdsapi = windows.NewLazySystemDLL("NTDSAPI.dll")
	procDsReplicaSyncAllA = ntdsapi.NewProc("DsReplicaSyncAllA")
)

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

extern "ntdsapi" fn DsReplicaSyncAllA(
    hDS: ?*anyopaque, // HANDLE
    pszNameContext: [*c]const u8, // LPCSTR
    ulFlags: u32, // DWORD
    pFnCallBack: isize, // INT_PTR
    pCallbackData: ?*anyopaque, // void* optional
    pErrors: [*c][*c][*c]DS_REPSYNCALL_ERRINFOA // DS_REPSYNCALL_ERRINFOA*** optional, out
) callconv(std.os.windows.WINAPI) u32;
proc DsReplicaSyncAllA(
    hDS: pointer,  # HANDLE
    pszNameContext: cstring,  # LPCSTR
    ulFlags: uint32,  # DWORD
    pFnCallBack: int,  # INT_PTR
    pCallbackData: pointer,  # void* optional
    pErrors: ptr DS_REPSYNCALL_ERRINFOA  # DS_REPSYNCALL_ERRINFOA*** optional, out
): uint32 {.importc: "DsReplicaSyncAllA", stdcall, dynlib: "NTDSAPI.dll".}
pragma(lib, "ntdsapi");
extern(Windows)
uint DsReplicaSyncAllA(
    void* hDS,   // HANDLE
    const(char)* pszNameContext,   // LPCSTR
    uint ulFlags,   // DWORD
    ptrdiff_t pFnCallBack,   // INT_PTR
    void* pCallbackData,   // void* optional
    DS_REPSYNCALL_ERRINFOA*** pErrors   // DS_REPSYNCALL_ERRINFOA*** optional, out
);
ccall((:DsReplicaSyncAllA, "NTDSAPI.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cstring, UInt32, Int, Ptr{Cvoid}, Ptr{DS_REPSYNCALL_ERRINFOA}),
      hDS, pszNameContext, ulFlags, pFnCallBack, pCallbackData, pErrors)
# hDS : HANDLE -> Ptr{Cvoid}
# pszNameContext : LPCSTR -> Cstring
# ulFlags : DWORD -> UInt32
# pFnCallBack : INT_PTR -> Int
# pCallbackData : void* optional -> Ptr{Cvoid}
# pErrors : DS_REPSYNCALL_ERRINFOA*** optional, out -> Ptr{DS_REPSYNCALL_ERRINFOA}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t DsReplicaSyncAllA(
    void* hDS,
    const char* pszNameContext,
    uint32_t ulFlags,
    intptr_t pFnCallBack,
    void* pCallbackData,
    void* pErrors);
]]
local ntdsapi = ffi.load("ntdsapi")
-- ntdsapi.DsReplicaSyncAllA(hDS, pszNameContext, ulFlags, pFnCallBack, pCallbackData, pErrors)
-- hDS : HANDLE
-- pszNameContext : LPCSTR
-- ulFlags : DWORD
-- pFnCallBack : INT_PTR
-- pCallbackData : void* optional
-- pErrors : DS_REPSYNCALL_ERRINFOA*** optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NTDSAPI.dll');
const DsReplicaSyncAllA = lib.func('__stdcall', 'DsReplicaSyncAllA', 'uint32_t', ['void *', 'str', 'uint32_t', 'intptr_t', 'void *', 'void *']);
// DsReplicaSyncAllA(hDS, pszNameContext, ulFlags, pFnCallBack, pCallbackData, pErrors)
// hDS : HANDLE -> 'void *'
// pszNameContext : LPCSTR -> 'str'
// ulFlags : DWORD -> 'uint32_t'
// pFnCallBack : INT_PTR -> 'intptr_t'
// pCallbackData : void* optional -> 'void *'
// pErrors : DS_REPSYNCALL_ERRINFOA*** optional, out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NTDSAPI.dll", {
  DsReplicaSyncAllA: { parameters: ["pointer", "buffer", "u32", "isize", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.DsReplicaSyncAllA(hDS, pszNameContext, ulFlags, pFnCallBack, pCallbackData, pErrors)
// hDS : HANDLE -> "pointer"
// pszNameContext : LPCSTR -> "buffer"
// ulFlags : DWORD -> "u32"
// pFnCallBack : INT_PTR -> "isize"
// pCallbackData : void* optional -> "pointer"
// pErrors : DS_REPSYNCALL_ERRINFOA*** optional, out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t DsReplicaSyncAllA(
    void* hDS,
    const char* pszNameContext,
    uint32_t ulFlags,
    intptr_t pFnCallBack,
    void* pCallbackData,
    void* pErrors);
C, "NTDSAPI.dll");
// $ffi->DsReplicaSyncAllA(hDS, pszNameContext, ulFlags, pFnCallBack, pCallbackData, pErrors);
// hDS : HANDLE
// pszNameContext : LPCSTR
// ulFlags : DWORD
// pFnCallBack : INT_PTR
// pCallbackData : void* optional
// pErrors : DS_REPSYNCALL_ERRINFOA*** optional, 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 DsReplicaSyncAllA(
        Pointer hDS,   // HANDLE
        String pszNameContext,   // LPCSTR
        int ulFlags,   // DWORD
        long pFnCallBack,   // INT_PTR
        Pointer pCallbackData,   // void* optional
        Pointer pErrors   // DS_REPSYNCALL_ERRINFOA*** optional, out
    );
}
@[Link("ntdsapi")]
lib LibNTDSAPI
  fun DsReplicaSyncAllA = DsReplicaSyncAllA(
    hDS : Void*,   # HANDLE
    pszNameContext : UInt8*,   # LPCSTR
    ulFlags : UInt32,   # DWORD
    pFnCallBack : LibC::SSizeT,   # INT_PTR
    pCallbackData : Void*,   # void* optional
    pErrors : DS_REPSYNCALL_ERRINFOA***   # DS_REPSYNCALL_ERRINFOA*** optional, out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DsReplicaSyncAllANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, Uint32, IntPtr, Pointer<Void>, Pointer<Void>);
typedef DsReplicaSyncAllADart = int Function(Pointer<Void>, Pointer<Utf8>, int, int, Pointer<Void>, Pointer<Void>);
final DsReplicaSyncAllA = DynamicLibrary.open('NTDSAPI.dll')
    .lookupFunction<DsReplicaSyncAllANative, DsReplicaSyncAllADart>('DsReplicaSyncAllA');
// hDS : HANDLE -> Pointer<Void>
// pszNameContext : LPCSTR -> Pointer<Utf8>
// ulFlags : DWORD -> Uint32
// pFnCallBack : INT_PTR -> IntPtr
// pCallbackData : void* optional -> Pointer<Void>
// pErrors : DS_REPSYNCALL_ERRINFOA*** optional, out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DsReplicaSyncAllA(
  hDS: THandle;   // HANDLE
  pszNameContext: PAnsiChar;   // LPCSTR
  ulFlags: DWORD;   // DWORD
  pFnCallBack: NativeInt;   // INT_PTR
  pCallbackData: Pointer;   // void* optional
  pErrors: Pointer   // DS_REPSYNCALL_ERRINFOA*** optional, out
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsReplicaSyncAllA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DsReplicaSyncAllA"
  c_DsReplicaSyncAllA :: Ptr () -> CString -> Word32 -> CIntPtr -> Ptr () -> Ptr () -> IO Word32
-- hDS : HANDLE -> Ptr ()
-- pszNameContext : LPCSTR -> CString
-- ulFlags : DWORD -> Word32
-- pFnCallBack : INT_PTR -> CIntPtr
-- pCallbackData : void* optional -> Ptr ()
-- pErrors : DS_REPSYNCALL_ERRINFOA*** optional, out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dsreplicasyncalla =
  foreign "DsReplicaSyncAllA"
    ((ptr void) @-> string @-> uint32_t @-> intptr_t @-> (ptr void) @-> (ptr void) @-> returning uint32_t)
(* hDS : HANDLE -> (ptr void) *)
(* pszNameContext : LPCSTR -> string *)
(* ulFlags : DWORD -> uint32_t *)
(* pFnCallBack : INT_PTR -> intptr_t *)
(* pCallbackData : void* optional -> (ptr void) *)
(* pErrors : DS_REPSYNCALL_ERRINFOA*** optional, 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 ("DsReplicaSyncAllA" ds-replica-sync-all-a :convention :stdcall) :uint32
  (h-ds :pointer)   ; HANDLE
  (psz-name-context :string)   ; LPCSTR
  (ul-flags :uint32)   ; DWORD
  (p-fn-call-back :int64)   ; INT_PTR
  (p-callback-data :pointer)   ; void* optional
  (p-errors :pointer))   ; DS_REPSYNCALL_ERRINFOA*** optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DsReplicaSyncAllA = Win32::API::More->new('NTDSAPI',
    'DWORD DsReplicaSyncAllA(HANDLE hDS, LPCSTR pszNameContext, DWORD ulFlags, LPARAM pFnCallBack, LPVOID pCallbackData, LPVOID pErrors)');
# my $ret = $DsReplicaSyncAllA->Call($hDS, $pszNameContext, $ulFlags, $pFnCallBack, $pCallbackData, $pErrors);
# hDS : HANDLE -> HANDLE
# pszNameContext : LPCSTR -> LPCSTR
# ulFlags : DWORD -> DWORD
# pFnCallBack : INT_PTR -> LPARAM
# pCallbackData : void* optional -> LPVOID
# pErrors : DS_REPSYNCALL_ERRINFOA*** optional, out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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