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

DsReplicaAddA

関数
複製元サーバーをレプリケーション構成に追加する(ANSI版)。
DLLNTDSAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

DWORD DsReplicaAddA(
    HANDLE hDS,
    LPCSTR NameContext,
    LPCSTR SourceDsaDn,
    LPCSTR TransportDn,
    LPCSTR SourceDsaAddress,
    const SCHEDULE* pSchedule,   // optional
    DWORD Options
);

パラメーター

名前方向説明
hDSHANDLEin操作に用いるディレクトリサービスバインドハンドル。
NameContextLPCSTRin複製対象の名前付けコンテキストのDN(ANSI)。
SourceDsaDnLPCSTRin複製元DSAのオブジェクトDN。
TransportDnLPCSTRinサイト間トランスポートのDN。サイト内ではNULL。
SourceDsaAddressLPCSTRin複製元DSAのネットワークアドレス(GUIDベースのDNS名等)。
pScheduleSCHEDULE*inoptional複製スケジュールを示すSCHEDULE構造体へのポインタ。NULL可。
OptionsDWORDin複製リンクの動作を制御するDS_REPADD_*フラグ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DsReplicaAddA(
    HANDLE hDS,
    LPCSTR NameContext,
    LPCSTR SourceDsaDn,
    LPCSTR TransportDn,
    LPCSTR SourceDsaAddress,
    const SCHEDULE* pSchedule,   // optional
    DWORD Options
);
[DllImport("NTDSAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint DsReplicaAddA(
    IntPtr hDS,   // HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string NameContext,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string SourceDsaDn,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string TransportDn,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string SourceDsaAddress,   // LPCSTR
    IntPtr pSchedule,   // SCHEDULE* optional
    uint Options   // DWORD
);
<DllImport("NTDSAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function DsReplicaAddA(
    hDS As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPStr)> NameContext As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> SourceDsaDn As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> TransportDn As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> SourceDsaAddress As String,   ' LPCSTR
    pSchedule As IntPtr,   ' SCHEDULE* optional
    Options As UInteger   ' DWORD
) As UInteger
End Function
' hDS : HANDLE
' NameContext : LPCSTR
' SourceDsaDn : LPCSTR
' TransportDn : LPCSTR
' SourceDsaAddress : LPCSTR
' pSchedule : SCHEDULE* optional
' Options : DWORD
Declare PtrSafe Function DsReplicaAddA Lib "ntdsapi" ( _
    ByVal hDS As LongPtr, _
    ByVal NameContext As String, _
    ByVal SourceDsaDn As String, _
    ByVal TransportDn As String, _
    ByVal SourceDsaAddress As String, _
    ByVal pSchedule As LongPtr, _
    ByVal Options As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DsReplicaAddA = ctypes.windll.ntdsapi.DsReplicaAddA
DsReplicaAddA.restype = wintypes.DWORD
DsReplicaAddA.argtypes = [
    wintypes.HANDLE,  # hDS : HANDLE
    wintypes.LPCSTR,  # NameContext : LPCSTR
    wintypes.LPCSTR,  # SourceDsaDn : LPCSTR
    wintypes.LPCSTR,  # TransportDn : LPCSTR
    wintypes.LPCSTR,  # SourceDsaAddress : LPCSTR
    ctypes.c_void_p,  # pSchedule : SCHEDULE* optional
    wintypes.DWORD,  # Options : DWORD
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ntdsapi = windows.NewLazySystemDLL("NTDSAPI.dll")
	procDsReplicaAddA = ntdsapi.NewProc("DsReplicaAddA")
)

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

extern "ntdsapi" fn DsReplicaAddA(
    hDS: ?*anyopaque, // HANDLE
    NameContext: [*c]const u8, // LPCSTR
    SourceDsaDn: [*c]const u8, // LPCSTR
    TransportDn: [*c]const u8, // LPCSTR
    SourceDsaAddress: [*c]const u8, // LPCSTR
    pSchedule: [*c]SCHEDULE, // SCHEDULE* optional
    Options: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc DsReplicaAddA(
    hDS: pointer,  # HANDLE
    NameContext: cstring,  # LPCSTR
    SourceDsaDn: cstring,  # LPCSTR
    TransportDn: cstring,  # LPCSTR
    SourceDsaAddress: cstring,  # LPCSTR
    pSchedule: ptr SCHEDULE,  # SCHEDULE* optional
    Options: uint32  # DWORD
): uint32 {.importc: "DsReplicaAddA", stdcall, dynlib: "NTDSAPI.dll".}
pragma(lib, "ntdsapi");
extern(Windows)
uint DsReplicaAddA(
    void* hDS,   // HANDLE
    const(char)* NameContext,   // LPCSTR
    const(char)* SourceDsaDn,   // LPCSTR
    const(char)* TransportDn,   // LPCSTR
    const(char)* SourceDsaAddress,   // LPCSTR
    SCHEDULE* pSchedule,   // SCHEDULE* optional
    uint Options   // DWORD
);
ccall((:DsReplicaAddA, "NTDSAPI.dll"), stdcall, UInt32,
      (Ptr{Cvoid}, Cstring, Cstring, Cstring, Cstring, Ptr{SCHEDULE}, UInt32),
      hDS, NameContext, SourceDsaDn, TransportDn, SourceDsaAddress, pSchedule, Options)
# hDS : HANDLE -> Ptr{Cvoid}
# NameContext : LPCSTR -> Cstring
# SourceDsaDn : LPCSTR -> Cstring
# TransportDn : LPCSTR -> Cstring
# SourceDsaAddress : LPCSTR -> Cstring
# pSchedule : SCHEDULE* optional -> Ptr{SCHEDULE}
# Options : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t DsReplicaAddA(
    void* hDS,
    const char* NameContext,
    const char* SourceDsaDn,
    const char* TransportDn,
    const char* SourceDsaAddress,
    void* pSchedule,
    uint32_t Options);
]]
local ntdsapi = ffi.load("ntdsapi")
-- ntdsapi.DsReplicaAddA(hDS, NameContext, SourceDsaDn, TransportDn, SourceDsaAddress, pSchedule, Options)
-- hDS : HANDLE
-- NameContext : LPCSTR
-- SourceDsaDn : LPCSTR
-- TransportDn : LPCSTR
-- SourceDsaAddress : LPCSTR
-- pSchedule : SCHEDULE* optional
-- Options : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('NTDSAPI.dll');
const DsReplicaAddA = lib.func('__stdcall', 'DsReplicaAddA', 'uint32_t', ['void *', 'str', 'str', 'str', 'str', 'void *', 'uint32_t']);
// DsReplicaAddA(hDS, NameContext, SourceDsaDn, TransportDn, SourceDsaAddress, pSchedule, Options)
// hDS : HANDLE -> 'void *'
// NameContext : LPCSTR -> 'str'
// SourceDsaDn : LPCSTR -> 'str'
// TransportDn : LPCSTR -> 'str'
// SourceDsaAddress : LPCSTR -> 'str'
// pSchedule : SCHEDULE* optional -> 'void *'
// Options : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("NTDSAPI.dll", {
  DsReplicaAddA: { parameters: ["pointer", "buffer", "buffer", "buffer", "buffer", "pointer", "u32"], result: "u32" },
});
// lib.symbols.DsReplicaAddA(hDS, NameContext, SourceDsaDn, TransportDn, SourceDsaAddress, pSchedule, Options)
// hDS : HANDLE -> "pointer"
// NameContext : LPCSTR -> "buffer"
// SourceDsaDn : LPCSTR -> "buffer"
// TransportDn : LPCSTR -> "buffer"
// SourceDsaAddress : LPCSTR -> "buffer"
// pSchedule : SCHEDULE* optional -> "pointer"
// Options : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t DsReplicaAddA(
    void* hDS,
    const char* NameContext,
    const char* SourceDsaDn,
    const char* TransportDn,
    const char* SourceDsaAddress,
    void* pSchedule,
    uint32_t Options);
C, "NTDSAPI.dll");
// $ffi->DsReplicaAddA(hDS, NameContext, SourceDsaDn, TransportDn, SourceDsaAddress, pSchedule, Options);
// hDS : HANDLE
// NameContext : LPCSTR
// SourceDsaDn : LPCSTR
// TransportDn : LPCSTR
// SourceDsaAddress : LPCSTR
// pSchedule : SCHEDULE* optional
// 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.ASCII_OPTIONS);
    int DsReplicaAddA(
        Pointer hDS,   // HANDLE
        String NameContext,   // LPCSTR
        String SourceDsaDn,   // LPCSTR
        String TransportDn,   // LPCSTR
        String SourceDsaAddress,   // LPCSTR
        Pointer pSchedule,   // SCHEDULE* optional
        int Options   // DWORD
    );
}
@[Link("ntdsapi")]
lib LibNTDSAPI
  fun DsReplicaAddA = DsReplicaAddA(
    hDS : Void*,   # HANDLE
    NameContext : UInt8*,   # LPCSTR
    SourceDsaDn : UInt8*,   # LPCSTR
    TransportDn : UInt8*,   # LPCSTR
    SourceDsaAddress : UInt8*,   # LPCSTR
    pSchedule : SCHEDULE*,   # SCHEDULE* optional
    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 DsReplicaAddANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>, Uint32);
typedef DsReplicaAddADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Void>, int);
final DsReplicaAddA = DynamicLibrary.open('NTDSAPI.dll')
    .lookupFunction<DsReplicaAddANative, DsReplicaAddADart>('DsReplicaAddA');
// hDS : HANDLE -> Pointer<Void>
// NameContext : LPCSTR -> Pointer<Utf8>
// SourceDsaDn : LPCSTR -> Pointer<Utf8>
// TransportDn : LPCSTR -> Pointer<Utf8>
// SourceDsaAddress : LPCSTR -> Pointer<Utf8>
// pSchedule : SCHEDULE* optional -> Pointer<Void>
// Options : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DsReplicaAddA(
  hDS: THandle;   // HANDLE
  NameContext: PAnsiChar;   // LPCSTR
  SourceDsaDn: PAnsiChar;   // LPCSTR
  TransportDn: PAnsiChar;   // LPCSTR
  SourceDsaAddress: PAnsiChar;   // LPCSTR
  pSchedule: Pointer;   // SCHEDULE* optional
  Options: DWORD   // DWORD
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsReplicaAddA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DsReplicaAddA"
  c_DsReplicaAddA :: Ptr () -> CString -> CString -> CString -> CString -> Ptr () -> Word32 -> IO Word32
-- hDS : HANDLE -> Ptr ()
-- NameContext : LPCSTR -> CString
-- SourceDsaDn : LPCSTR -> CString
-- TransportDn : LPCSTR -> CString
-- SourceDsaAddress : LPCSTR -> CString
-- pSchedule : SCHEDULE* optional -> Ptr ()
-- Options : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dsreplicaadda =
  foreign "DsReplicaAddA"
    ((ptr void) @-> string @-> string @-> string @-> string @-> (ptr void) @-> uint32_t @-> returning uint32_t)
(* hDS : HANDLE -> (ptr void) *)
(* NameContext : LPCSTR -> string *)
(* SourceDsaDn : LPCSTR -> string *)
(* TransportDn : LPCSTR -> string *)
(* SourceDsaAddress : LPCSTR -> string *)
(* pSchedule : SCHEDULE* optional -> (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 ("DsReplicaAddA" ds-replica-add-a :convention :stdcall) :uint32
  (h-ds :pointer)   ; HANDLE
  (name-context :string)   ; LPCSTR
  (source-dsa-dn :string)   ; LPCSTR
  (transport-dn :string)   ; LPCSTR
  (source-dsa-address :string)   ; LPCSTR
  (p-schedule :pointer)   ; SCHEDULE* optional
  (options :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DsReplicaAddA = Win32::API::More->new('NTDSAPI',
    'DWORD DsReplicaAddA(HANDLE hDS, LPCSTR NameContext, LPCSTR SourceDsaDn, LPCSTR TransportDn, LPCSTR SourceDsaAddress, LPVOID pSchedule, DWORD Options)');
# my $ret = $DsReplicaAddA->Call($hDS, $NameContext, $SourceDsaDn, $TransportDn, $SourceDsaAddress, $pSchedule, $Options);
# hDS : HANDLE -> HANDLE
# NameContext : LPCSTR -> LPCSTR
# SourceDsaDn : LPCSTR -> LPCSTR
# TransportDn : LPCSTR -> LPCSTR
# SourceDsaAddress : LPCSTR -> LPCSTR
# pSchedule : SCHEDULE* optional -> LPVOID
# Options : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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