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

DsReplicaUpdateRefsW

関数
複製先サーバーへの参照を更新する(Unicode版)。
DLLNTDSAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

// NTDSAPI.dll  (Unicode / -W)
#include <windows.h>

DWORD DsReplicaUpdateRefsW(
    HANDLE hDS,
    LPCWSTR NameContext,
    LPCWSTR DsaDest,
    const GUID* pUuidDsaDest,
    DWORD Options
);

パラメーター

名前型方向説明
hDSHANDLEinDSBind 関数または DSBindWithCred 関数から取得したディレクトリ サービス ハンドルを格納します。
NameContextLPCWSTRinコピー元の名前付けコンテキストの識別名を指定する、null で終わる定数文字列へのポインター。
DsaDestLPCWSTRinコピー先のディレクトリ システム エージェントのトランスポート固有のアドレスを指定する、null で終わる定数文字列へのポインター。
pUuidDsaDestGUID*inコピー先のディレクトリ システム エージェントを示す UUID 値へのポインター。
OptionsDWORDin

要求の処理に使用される追加情報を提供するフラグのセットを格納します。0 を指定するか、次の値のうち 1 つ以上を組み合わせて指定できます。

DS_REPUPD_ADD_REFERENCE

コピー先への参照がコピー元サーバーに追加されます。

DS_REPUPD_ASYNCHRONOUS_OPERATION

操作は非同期に実行されます。

DS_REPUPD_DELETE_REFERENCE

コピー先への参照がコピー元サーバーから削除されます。

DS_REPUPD_WRITEABLE

追加または削除されるレプリカへの参照は書き込み可能です。それ以外の場合は読み取り専用です。

- Options.DS_REPUPD_ADD_REFERENCE

コピー先への参照がコピー元サーバーに追加されます。

- Options.DS_REPUPD_ASYNCHRONOUS_OPERATION

操作は非同期に実行されます。

- Options.DS_REPUPD_DELETE_REFERENCE

コピー先への参照がコピー元サーバーから削除されます。

- Options.DS_REPUPD_WRITEABLE

追加または削除されるレプリカへの参照は書き込み可能です。それ以外の場合は読み取り専用です。

戻り値の型: DWORD

公式ドキュメント

コピー元の名前付けコンテキストに対して、コピー先への複製参照を追加または削除します。(Unicode)

戻り値

関数が成功した場合は ERROR_SUCCESS が返されます。

関数が失敗した場合、戻り値は次のいずれかになります。

解説(Remarks)

Options パラメーターに DS_REPUPD_ADD_REFERENCE と DS_REPUPD_DELETE_REFERENCE の両方が設定されている場合、コピー先への参照がサーバー上にまだ存在しなければ、その参照が追加されます。コピー先への参照が既に存在する場合は、その参照が更新されます。

メモ

ntdsapi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして DsReplicaUpdateRefs を定義しています。エンコード中立のエイリアスの使用と、エンコード中立でないコードを混在させると不整合が生じ、コンパイル エラーや実行時エラーの原因となる場合があります。詳細については、「Conventions for Function Prototypes」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// NTDSAPI.dll  (Unicode / -W)
#include <windows.h>

DWORD DsReplicaUpdateRefsW(
    HANDLE hDS,
    LPCWSTR NameContext,
    LPCWSTR DsaDest,
    const GUID* pUuidDsaDest,
    DWORD Options
);
[DllImport("NTDSAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint DsReplicaUpdateRefsW(
    IntPtr hDS,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string NameContext,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string DsaDest,   // LPCWSTR
    ref Guid pUuidDsaDest,   // GUID*
    uint Options   // DWORD
);
<DllImport("NTDSAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function DsReplicaUpdateRefsW(
    hDS As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> NameContext As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> DsaDest As String,   ' LPCWSTR
    ByRef pUuidDsaDest As Guid,   ' GUID*
    Options As UInteger   ' DWORD
) As UInteger
End Function
' hDS : HANDLE
' NameContext : LPCWSTR
' DsaDest : LPCWSTR
' pUuidDsaDest : GUID*
' Options : DWORD
Declare PtrSafe Function DsReplicaUpdateRefsW Lib "ntdsapi" ( _
    ByVal hDS As LongPtr, _
    ByVal NameContext As LongPtr, _
    ByVal DsaDest As LongPtr, _
    ByVal pUuidDsaDest As LongPtr, _
    ByVal Options As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DsReplicaUpdateRefsW = ctypes.windll.ntdsapi.DsReplicaUpdateRefsW
DsReplicaUpdateRefsW.restype = wintypes.DWORD
DsReplicaUpdateRefsW.argtypes = [
    wintypes.HANDLE,  # hDS : HANDLE
    wintypes.LPCWSTR,  # NameContext : LPCWSTR
    wintypes.LPCWSTR,  # DsaDest : LPCWSTR
    ctypes.c_void_p,  # pUuidDsaDest : GUID*
    wintypes.DWORD,  # Options : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ntdsapi = windows.NewLazySystemDLL("NTDSAPI.dll")
	procDsReplicaUpdateRefsW = ntdsapi.NewProc("DsReplicaUpdateRefsW")
)

// hDS (HANDLE), NameContext (LPCWSTR), DsaDest (LPCWSTR), pUuidDsaDest (GUID*), Options (DWORD)
r1, _, err := procDsReplicaUpdateRefsW.Call(
	uintptr(hDS),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(NameContext))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(DsaDest))),
	uintptr(pUuidDsaDest),
	uintptr(Options),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function DsReplicaUpdateRefsW(
  hDS: THandle;   // HANDLE
  NameContext: PWideChar;   // LPCWSTR
  DsaDest: PWideChar;   // LPCWSTR
  pUuidDsaDest: PGUID;   // GUID*
  Options: DWORD   // DWORD
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsReplicaUpdateRefsW';
result := DllCall("NTDSAPI\DsReplicaUpdateRefsW"
    , "Ptr", hDS   ; HANDLE
    , "WStr", NameContext   ; LPCWSTR
    , "WStr", DsaDest   ; LPCWSTR
    , "Ptr", pUuidDsaDest   ; GUID*
    , "UInt", Options   ; DWORD
    , "UInt")   ; return: DWORD
●DsReplicaUpdateRefsW(hDS, NameContext, DsaDest, pUuidDsaDest, Options) = DLL("NTDSAPI.dll", "dword DsReplicaUpdateRefsW(void*, char*, char*, void*, dword)")
# 呼び出し: DsReplicaUpdateRefsW(hDS, NameContext, DsaDest, pUuidDsaDest, Options)
# hDS : HANDLE -> "void*"
# NameContext : LPCWSTR -> "char*"
# DsaDest : LPCWSTR -> "char*"
# pUuidDsaDest : GUID* -> "void*"
# Options : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "ntdsapi" fn DsReplicaUpdateRefsW(
    hDS: ?*anyopaque, // HANDLE
    NameContext: [*c]const u16, // LPCWSTR
    DsaDest: [*c]const u16, // LPCWSTR
    pUuidDsaDest: [*c]GUID, // GUID*
    Options: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc DsReplicaUpdateRefsW(
    hDS: pointer,  # HANDLE
    NameContext: WideCString,  # LPCWSTR
    DsaDest: WideCString,  # LPCWSTR
    pUuidDsaDest: ptr GUID,  # GUID*
    Options: uint32  # DWORD
): uint32 {.importc: "DsReplicaUpdateRefsW", stdcall, dynlib: "NTDSAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "ntdsapi");
extern(Windows)
uint DsReplicaUpdateRefsW(
    void* hDS,   // HANDLE
    const(wchar)* NameContext,   // LPCWSTR
    const(wchar)* DsaDest,   // LPCWSTR
    GUID* pUuidDsaDest,   // GUID*
    uint Options   // DWORD
);
ccall((:DsReplicaUpdateRefsW, "NTDSAPI.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cwstring, Cwstring, Ptr{GUID}, UInt32),
      hDS, NameContext, DsaDest, pUuidDsaDest, Options)
# hDS : HANDLE -> Ptr{Cvoid}
# NameContext : LPCWSTR -> Cwstring
# DsaDest : LPCWSTR -> Cwstring
# pUuidDsaDest : GUID* -> Ptr{GUID}
# Options : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t DsReplicaUpdateRefsW(
    void* hDS,
    const uint16_t* NameContext,
    const uint16_t* DsaDest,
    void* pUuidDsaDest,
    uint32_t Options);
]]
local ntdsapi = ffi.load("ntdsapi")
-- ntdsapi.DsReplicaUpdateRefsW(hDS, NameContext, DsaDest, pUuidDsaDest, Options)
-- hDS : HANDLE
-- NameContext : LPCWSTR
-- DsaDest : LPCWSTR
-- pUuidDsaDest : GUID*
-- Options : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('NTDSAPI.dll');
const DsReplicaUpdateRefsW = lib.func('__stdcall', 'DsReplicaUpdateRefsW', 'uint32_t', ['void *', 'str16', 'str16', 'void *', 'uint32_t']);
// DsReplicaUpdateRefsW(hDS, NameContext, DsaDest, pUuidDsaDest, Options)
// hDS : HANDLE -> 'void *'
// NameContext : LPCWSTR -> 'str16'
// DsaDest : LPCWSTR -> 'str16'
// pUuidDsaDest : GUID* -> 'void *'
// Options : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NTDSAPI.dll", {
  DsReplicaUpdateRefsW: { parameters: ["pointer", "buffer", "buffer", "pointer", "u32"], result: "u32" },
});
// lib.symbols.DsReplicaUpdateRefsW(hDS, NameContext, DsaDest, pUuidDsaDest, Options)
// hDS : HANDLE -> "pointer"
// NameContext : LPCWSTR -> "buffer"
// DsaDest : LPCWSTR -> "buffer"
// pUuidDsaDest : GUID* -> "pointer"
// Options : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t DsReplicaUpdateRefsW(
    void* hDS,
    const uint16_t* NameContext,
    const uint16_t* DsaDest,
    void* pUuidDsaDest,
    uint32_t Options);
C, "NTDSAPI.dll");
// $ffi->DsReplicaUpdateRefsW(hDS, NameContext, DsaDest, pUuidDsaDest, Options);
// hDS : HANDLE
// NameContext : LPCWSTR
// DsaDest : LPCWSTR
// pUuidDsaDest : GUID*
// Options : 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, W32APIOptions.UNICODE_OPTIONS);
    int DsReplicaUpdateRefsW(
        Pointer hDS,   // HANDLE
        WString NameContext,   // LPCWSTR
        WString DsaDest,   // LPCWSTR
        Pointer pUuidDsaDest,   // GUID*
        int Options   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("ntdsapi")]
lib LibNTDSAPI
  fun DsReplicaUpdateRefsW = DsReplicaUpdateRefsW(
    hDS : Void*,   # HANDLE
    NameContext : UInt16*,   # LPCWSTR
    DsaDest : UInt16*,   # LPCWSTR
    pUuidDsaDest : GUID*,   # GUID*
    Options : 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 DsReplicaUpdateRefsWNative = Uint32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, Uint32);
typedef DsReplicaUpdateRefsWDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Pointer<Void>, int);
final DsReplicaUpdateRefsW = DynamicLibrary.open('NTDSAPI.dll')
    .lookupFunction<DsReplicaUpdateRefsWNative, DsReplicaUpdateRefsWDart>('DsReplicaUpdateRefsW');
// hDS : HANDLE -> Pointer<Void>
// NameContext : LPCWSTR -> Pointer<Utf16>
// DsaDest : LPCWSTR -> Pointer<Utf16>
// pUuidDsaDest : GUID* -> Pointer<Void>
// Options : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DsReplicaUpdateRefsW(
  hDS: THandle;   // HANDLE
  NameContext: PWideChar;   // LPCWSTR
  DsaDest: PWideChar;   // LPCWSTR
  pUuidDsaDest: PGUID;   // GUID*
  Options: DWORD   // DWORD
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsReplicaUpdateRefsW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DsReplicaUpdateRefsW"
  c_DsReplicaUpdateRefsW :: Ptr () -> CWString -> CWString -> Ptr () -> Word32 -> IO Word32
-- hDS : HANDLE -> Ptr ()
-- NameContext : LPCWSTR -> CWString
-- DsaDest : LPCWSTR -> CWString
-- pUuidDsaDest : GUID* -> Ptr ()
-- Options : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dsreplicaupdaterefsw =
  foreign "DsReplicaUpdateRefsW"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> uint32_t @-> returning uint32_t)
(* hDS : HANDLE -> (ptr void) *)
(* NameContext : LPCWSTR -> (ptr uint16_t) *)
(* DsaDest : LPCWSTR -> (ptr uint16_t) *)
(* pUuidDsaDest : GUID* -> (ptr void) *)
(* Options : 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 ("DsReplicaUpdateRefsW" ds-replica-update-refs-w :convention :stdcall) :uint32
  (h-ds :pointer)   ; HANDLE
  (name-context (:string :encoding :utf-16le))   ; LPCWSTR
  (dsa-dest (:string :encoding :utf-16le))   ; LPCWSTR
  (p-uuid-dsa-dest :pointer)   ; GUID*
  (options :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DsReplicaUpdateRefsW = Win32::API::More->new('NTDSAPI',
    'DWORD DsReplicaUpdateRefsW(HANDLE hDS, LPCWSTR NameContext, LPCWSTR DsaDest, LPVOID pUuidDsaDest, DWORD Options)');
# my $ret = $DsReplicaUpdateRefsW->Call($hDS, $NameContext, $DsaDest, $pUuidDsaDest, $Options);
# hDS : HANDLE -> HANDLE
# NameContext : LPCWSTR -> LPCWSTR
# DsaDest : LPCWSTR -> LPCWSTR
# pUuidDsaDest : GUID* -> LPVOID
# Options : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
公式の関連項目