ホーム › Networking.ActiveDirectory › DsReplicaDelW

DsReplicaDelW

関数

複製元サーバーをレプリケーション構成から削除する(Unicode版)。

DLLNTDSAPI.dll文字セットUnicode (-W)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD DsReplicaDelW(
    HANDLE hDS,
    LPCWSTR NameContext,
    LPCWSTR DsaSrc,
    DWORD Options
);

パラメーター

名前	型	方向	説明
hDS	HANDLE	in	DSBind 関数または DSBindWithCred 関数で取得したディレクトリサービスハンドルを格納します。
NameContext	LPCWSTR	in	レプリカの削除対象となる宛先 NC の識別名 (DN) を指定する、定数の null 終端文字列へのポインターです。宛先 NC のレコードは、インスタンス化されているかどうかにかかわらずオブジェクトとして、または参照ファントム (GUID を持つファントムなど) として、ローカルに存在している必要があります。
DsaSrc	LPCWSTR	in	ソースディレクトリシステムエージェント (DSA) のトランスポート固有のアドレスを指定する、定数の null 終端 Unicode 文字列へのポインターです。このソースサーバーは UUID ではなく文字列名で識別されます。DsaSrc に適した文字列名は、通常は GUID に基づく DNS 名であり、その名前の GUID 部分はソースサーバーの nTDSDSA オブジェクトの GUID です。
Options	DWORD	in	要求の処理に使用される追加のデータを渡します。このパラメーターには、次の値の組み合わせを指定できます。 DS_REPDEL_ASYNCHRONOUS_OPERATION この操作を非同期的に実行します。 DS_REPDEL_IGNORE_ERRORS レプリケート先サーバーの一覧からこの NC を削除するようソースに指示するために、ソースへ接続する際に発生したエラーをすべて無視します。 DS_REPDEL_INTERSITE_MESSAGING レプリカが、ネイティブのディレクトリサービス RPC による同期ではなく、メールベースであることを示します。 DS_REPDEL_LOCAL_ONLY レプリケート先サーバーの一覧からこの NC を削除するようソースに指示するための接続を行いません。このフラグが設定されておらず、リンクが RPC に基づく場合は、ソースへ接続します。 DS_REPDEL_NO_SOURCE NC 内のすべてのオブジェクトを削除します。このオプションは、ソースを持たない読み取り専用の NC に対してのみ有効です。 DS_REPDEL_REF_OK 読み取り専用レプリカが他の読み取り専用レプリカのソースとなっている場合でも、その削除を許可します。 DS_REPDEL_WRITEABLE 削除されるレプリカが書き込み可能であることを示します。 - Options.DS_REPDEL_ASYNCHRONOUS_OPERATION この操作を非同期的に実行します。 - Options.DS_REPDEL_IGNORE_ERRORS レプリケート先サーバーの一覧からこの NC を削除するようソースに指示するために、ソースへ接続する際に発生したエラーをすべて無視します。 - Options.DS_REPDEL_INTERSITE_MESSAGING レプリカが、ネイティブのディレクトリサービス RPC による同期ではなく、メールベースであることを示します。 - Options.DS_REPDEL_LOCAL_ONLY レプリケート先サーバーの一覧からこの NC を削除するようソースに指示するための接続を行いません。このフラグが設定されておらず、リンクが RPC に基づく場合は、ソースへ接続します。 - Options.DS_REPDEL_NO_SOURCE NC 内のすべてのオブジェクトを削除します。このオプションは、ソースを持たない読み取り専用の NC に対してのみ有効です。 - Options.DS_REPDEL_REF_OK 読み取り専用レプリカが他の読み取り専用レプリカのソースとなっている場合でも、その削除を許可します。 - Options.DS_REPDEL_WRITEABLE 削除されるレプリカが書き込み可能であることを示します。

戻り値の型: DWORD

公式ドキュメント

レプリケーションソースの参照を、宛先の名前付けコンテキスト (NC) から削除します。(Unicode)

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS です。

関数が失敗した場合、戻り値は標準の Win32 API エラー、またはパラメーターが無効な場合は ERROR_INVALID_PARAMETER です。

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 DsReplicaDelW(
    HANDLE hDS,
    LPCWSTR NameContext,
    LPCWSTR DsaSrc,
    DWORD Options
);

[DllImport("NTDSAPI.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint DsReplicaDelW(
    IntPtr hDS,   // HANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string NameContext,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string DsaSrc,   // LPCWSTR
    uint Options   // DWORD
);

<DllImport("NTDSAPI.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function DsReplicaDelW(
    hDS As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPWStr)> NameContext As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> DsaSrc As String,   ' LPCWSTR
    Options As UInteger   ' DWORD
) As UInteger
End Function

' hDS : HANDLE
' NameContext : LPCWSTR
' DsaSrc : LPCWSTR
' Options : DWORD
Declare PtrSafe Function DsReplicaDelW Lib "ntdsapi" ( _
    ByVal hDS As LongPtr, _
    ByVal NameContext As LongPtr, _
    ByVal DsaSrc 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

DsReplicaDelW = ctypes.windll.ntdsapi.DsReplicaDelW
DsReplicaDelW.restype = wintypes.DWORD
DsReplicaDelW.argtypes = [
    wintypes.HANDLE,  # hDS : HANDLE
    wintypes.LPCWSTR,  # NameContext : LPCWSTR
    wintypes.LPCWSTR,  # DsaSrc : LPCWSTR
    wintypes.DWORD,  # Options : DWORD
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('NTDSAPI.dll')
DsReplicaDelW = Fiddle::Function.new(
  lib['DsReplicaDelW'],
  [
    Fiddle::TYPE_VOIDP,  # hDS : HANDLE
    Fiddle::TYPE_VOIDP,  # NameContext : LPCWSTR
    Fiddle::TYPE_VOIDP,  # DsaSrc : LPCWSTR
    -Fiddle::TYPE_INT,  # Options : DWORD
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "ntdsapi")]
extern "system" {
    fn DsReplicaDelW(
        hDS: *mut core::ffi::c_void,  // HANDLE
        NameContext: *const u16,  // LPCWSTR
        DsaSrc: *const u16,  // LPCWSTR
        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 DsReplicaDelW(IntPtr hDS, [MarshalAs(UnmanagedType.LPWStr)] string NameContext, [MarshalAs(UnmanagedType.LPWStr)] string DsaSrc, uint Options);
"@
$api = Add-Type -MemberDefinition $sig -Name 'NTDSAPI_DsReplicaDelW' -Namespace Win32 -PassThru
# $api::DsReplicaDelW(hDS, NameContext, DsaSrc, Options)

#uselib "NTDSAPI.dll"
#func global DsReplicaDelW "DsReplicaDelW" wptr, wptr, wptr, wptr
; DsReplicaDelW hDS, NameContext, DsaSrc, Options   ; 戻り値は stat
; hDS : HANDLE -> "wptr"
; NameContext : LPCWSTR -> "wptr"
; DsaSrc : LPCWSTR -> "wptr"
; Options : DWORD -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "NTDSAPI.dll"
#cfunc global DsReplicaDelW "DsReplicaDelW" sptr, wstr, wstr, int
; res = DsReplicaDelW(hDS, NameContext, DsaSrc, Options)
; hDS : HANDLE -> "sptr"
; NameContext : LPCWSTR -> "wstr"
; DsaSrc : LPCWSTR -> "wstr"
; Options : DWORD -> "int"

; DWORD DsReplicaDelW(HANDLE hDS, LPCWSTR NameContext, LPCWSTR DsaSrc, DWORD Options)
#uselib "NTDSAPI.dll"
#cfunc global DsReplicaDelW "DsReplicaDelW" intptr, wstr, wstr, int
; res = DsReplicaDelW(hDS, NameContext, DsaSrc, Options)
; hDS : HANDLE -> "intptr"
; NameContext : LPCWSTR -> "wstr"
; DsaSrc : LPCWSTR -> "wstr"
; Options : DWORD -> "int"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ntdsapi = windows.NewLazySystemDLL("NTDSAPI.dll")
	procDsReplicaDelW = ntdsapi.NewProc("DsReplicaDelW")
)

// hDS (HANDLE), NameContext (LPCWSTR), DsaSrc (LPCWSTR), Options (DWORD)
r1, _, err := procDsReplicaDelW.Call(
	uintptr(hDS),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(NameContext))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(DsaSrc))),
	uintptr(Options),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function DsReplicaDelW(
  hDS: THandle;   // HANDLE
  NameContext: PWideChar;   // LPCWSTR
  DsaSrc: PWideChar;   // LPCWSTR
  Options: DWORD   // DWORD
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsReplicaDelW';

result := DllCall("NTDSAPI\DsReplicaDelW"
    , "Ptr", hDS   ; HANDLE
    , "WStr", NameContext   ; LPCWSTR
    , "WStr", DsaSrc   ; LPCWSTR
    , "UInt", Options   ; DWORD
    , "UInt")   ; return: DWORD

●DsReplicaDelW(hDS, NameContext, DsaSrc, Options) = DLL("NTDSAPI.dll", "dword DsReplicaDelW(void*, char*, char*, dword)")
# 呼び出し: DsReplicaDelW(hDS, NameContext, DsaSrc, Options)
# hDS : HANDLE -> "void*"
# NameContext : LPCWSTR -> "char*"
# DsaSrc : LPCWSTR -> "char*"
# Options : DWORD -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。

const std = @import("std");

extern "ntdsapi" fn DsReplicaDelW(
    hDS: ?*anyopaque, // HANDLE
    NameContext: [*c]const u16, // LPCWSTR
    DsaSrc: [*c]const u16, // LPCWSTR
    Options: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。

proc DsReplicaDelW(
    hDS: pointer,  # HANDLE
    NameContext: WideCString,  # LPCWSTR
    DsaSrc: WideCString,  # LPCWSTR
    Options: uint32  # DWORD
): uint32 {.importc: "DsReplicaDelW", stdcall, dynlib: "NTDSAPI.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。

pragma(lib, "ntdsapi");
extern(Windows)
uint DsReplicaDelW(
    void* hDS,   // HANDLE
    const(wchar)* NameContext,   // LPCWSTR
    const(wchar)* DsaSrc,   // LPCWSTR
    uint Options   // DWORD
);

ccall((:DsReplicaDelW, "NTDSAPI.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cwstring, Cwstring, UInt32),
      hDS, NameContext, DsaSrc, Options)
# hDS : HANDLE -> Ptr{Cvoid}
# NameContext : LPCWSTR -> Cwstring
# DsaSrc : LPCWSTR -> Cwstring
# Options : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。

local ffi = require("ffi")
ffi.cdef[[
uint32_t DsReplicaDelW(
    void* hDS,
    const uint16_t* NameContext,
    const uint16_t* DsaSrc,
    uint32_t Options);
]]
local ntdsapi = ffi.load("ntdsapi")
-- ntdsapi.DsReplicaDelW(hDS, NameContext, DsaSrc, Options)
-- hDS : HANDLE
-- NameContext : LPCWSTR
-- DsaSrc : LPCWSTR
-- 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 DsReplicaDelW = lib.func('__stdcall', 'DsReplicaDelW', 'uint32_t', ['void *', 'str16', 'str16', 'uint32_t']);
// DsReplicaDelW(hDS, NameContext, DsaSrc, Options)
// hDS : HANDLE -> 'void *'
// NameContext : LPCWSTR -> 'str16'
// DsaSrc : LPCWSTR -> 'str16'
// Options : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("NTDSAPI.dll", {
  DsReplicaDelW: { parameters: ["pointer", "buffer", "buffer", "u32"], result: "u32" },
});
// lib.symbols.DsReplicaDelW(hDS, NameContext, DsaSrc, Options)
// hDS : HANDLE -> "pointer"
// NameContext : LPCWSTR -> "buffer"
// DsaSrc : LPCWSTR -> "buffer"
// Options : DWORD -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
uint32_t DsReplicaDelW(
    void* hDS,
    const uint16_t* NameContext,
    const uint16_t* DsaSrc,
    uint32_t Options);
C, "NTDSAPI.dll");
// $ffi->DsReplicaDelW(hDS, NameContext, DsaSrc, Options);
// hDS : HANDLE
// NameContext : LPCWSTR
// DsaSrc : LPCWSTR
// 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 DsReplicaDelW(
        Pointer hDS,   // HANDLE
        WString NameContext,   // LPCWSTR
        WString DsaSrc,   // LPCWSTR
        int Options   // DWORD
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。

@[Link("ntdsapi")]
lib LibNTDSAPI
  fun DsReplicaDelW = DsReplicaDelW(
    hDS : Void*,   # HANDLE
    NameContext : UInt16*,   # LPCWSTR
    DsaSrc : UInt16*,   # LPCWSTR
    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 DsReplicaDelWNative = Uint32 Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef DsReplicaDelWDart = int Function(Pointer<Void>, Pointer<Utf16>, Pointer<Utf16>, int);
final DsReplicaDelW = DynamicLibrary.open('NTDSAPI.dll')
    .lookupFunction<DsReplicaDelWNative, DsReplicaDelWDart>('DsReplicaDelW');
// hDS : HANDLE -> Pointer<Void>
// NameContext : LPCWSTR -> Pointer<Utf16>
// DsaSrc : LPCWSTR -> Pointer<Utf16>
// Options : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function DsReplicaDelW(
  hDS: THandle;   // HANDLE
  NameContext: PWideChar;   // LPCWSTR
  DsaSrc: PWideChar;   // LPCWSTR
  Options: DWORD   // DWORD
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsReplicaDelW';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DsReplicaDelW"
  c_DsReplicaDelW :: Ptr () -> CWString -> CWString -> Word32 -> IO Word32
-- hDS : HANDLE -> Ptr ()
-- NameContext : LPCWSTR -> CWString
-- DsaSrc : LPCWSTR -> CWString
-- Options : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let dsreplicadelw =
  foreign "DsReplicaDelW"
    ((ptr void) @-> (ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* hDS : HANDLE -> (ptr void) *)
(* NameContext : LPCWSTR -> (ptr uint16_t) *)
(* DsaSrc : LPCWSTR -> (ptr uint16_t) *)
(* 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 ("DsReplicaDelW" ds-replica-del-w :convention :stdcall) :uint32
  (h-ds :pointer)   ; HANDLE
  (name-context (:string :encoding :utf-16le))   ; LPCWSTR
  (dsa-src (:string :encoding :utf-16le))   ; LPCWSTR
  (options :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $DsReplicaDelW = Win32::API::More->new('NTDSAPI',
    'DWORD DsReplicaDelW(HANDLE hDS, LPCWSTR NameContext, LPCWSTR DsaSrc, DWORD Options)');
# my $ret = $DsReplicaDelW->Call($hDS, $NameContext, $DsaSrc, $Options);
# hDS : HANDLE -> HANDLE
# NameContext : LPCWSTR -> LPCWSTR
# DsaSrc : LPCWSTR -> LPCWSTR
# Options : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

DsReplicaDelW

シグネチャ

パラメーター

DS_REPDEL_ASYNCHRONOUS_OPERATION

DS_REPDEL_IGNORE_ERRORS

DS_REPDEL_INTERSITE_MESSAGING

DS_REPDEL_LOCAL_ONLY

DS_REPDEL_NO_SOURCE

DS_REPDEL_REF_OK

DS_REPDEL_WRITEABLE

- Options.DS_REPDEL_ASYNCHRONOUS_OPERATION

- Options.DS_REPDEL_IGNORE_ERRORS

- Options.DS_REPDEL_INTERSITE_MESSAGING

- Options.DS_REPDEL_LOCAL_ONLY

- Options.DS_REPDEL_NO_SOURCE

- Options.DS_REPDEL_REF_OK

- Options.DS_REPDEL_WRITEABLE

公式ドキュメント

戻り値

解説(Remarks)

各言語での呼び出し定義

関連項目