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

DsRemoveDsServerA

関数
ドメインからディレクトリサーバーを削除する(ANSI版)。
DLLNTDSAPI.dll文字セットANSI (-A)呼出規約winapi対応OSWindows Vista 以降
📘 Microsoft Learn (日本語) · English

シグネチャ

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

DWORD DsRemoveDsServerA(
    HANDLE hDs,
    LPSTR ServerDN,
    LPSTR DomainDN,   // optional
    BOOL* fLastDcInDomain,   // optional
    BOOL fCommit
);

パラメーター

名前型方向説明
hDsHANDLEin操作に用いるディレクトリサービスバインドハンドル。
ServerDNLPSTRin削除対象のサーバオブジェクトのDN(ANSI)。
DomainDNLPSTRinoptionalサーバが属するドメインのDN。NULL可。
fLastDcInDomainBOOL*outoptionalこのサーバがドメイン最後のDCかを受け取るBOOLへのポインタ。
fCommitBOOLinTRUEで実際に削除、FALSEで判定のみ行う。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DsRemoveDsServerA(
    HANDLE hDs,
    LPSTR ServerDN,
    LPSTR DomainDN,   // optional
    BOOL* fLastDcInDomain,   // optional
    BOOL fCommit
);
[DllImport("NTDSAPI.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint DsRemoveDsServerA(
    IntPtr hDs,   // HANDLE
    [MarshalAs(UnmanagedType.LPStr)] string ServerDN,   // LPSTR
    [MarshalAs(UnmanagedType.LPStr)] string DomainDN,   // LPSTR optional
    IntPtr fLastDcInDomain,   // BOOL* optional, out
    bool fCommit   // BOOL
);
<DllImport("NTDSAPI.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function DsRemoveDsServerA(
    hDs As IntPtr,   ' HANDLE
    <MarshalAs(UnmanagedType.LPStr)> ServerDN As String,   ' LPSTR
    <MarshalAs(UnmanagedType.LPStr)> DomainDN As String,   ' LPSTR optional
    fLastDcInDomain As IntPtr,   ' BOOL* optional, out
    fCommit As Boolean   ' BOOL
) As UInteger
End Function
' hDs : HANDLE
' ServerDN : LPSTR
' DomainDN : LPSTR optional
' fLastDcInDomain : BOOL* optional, out
' fCommit : BOOL
Declare PtrSafe Function DsRemoveDsServerA Lib "ntdsapi" ( _
    ByVal hDs As LongPtr, _
    ByVal ServerDN As String, _
    ByVal DomainDN As String, _
    ByVal fLastDcInDomain As LongPtr, _
    ByVal fCommit As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DsRemoveDsServerA = ctypes.windll.ntdsapi.DsRemoveDsServerA
DsRemoveDsServerA.restype = wintypes.DWORD
DsRemoveDsServerA.argtypes = [
    wintypes.HANDLE,  # hDs : HANDLE
    wintypes.LPCSTR,  # ServerDN : LPSTR
    wintypes.LPCSTR,  # DomainDN : LPSTR optional
    ctypes.c_void_p,  # fLastDcInDomain : BOOL* optional, out
    wintypes.BOOL,  # fCommit : BOOL
]
require 'fiddle'
require 'fiddle/import'

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

var (
	ntdsapi = windows.NewLazySystemDLL("NTDSAPI.dll")
	procDsRemoveDsServerA = ntdsapi.NewProc("DsRemoveDsServerA")
)

// hDs (HANDLE), ServerDN (LPSTR), DomainDN (LPSTR optional), fLastDcInDomain (BOOL* optional, out), fCommit (BOOL)
r1, _, err := procDsRemoveDsServerA.Call(
	uintptr(hDs),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(ServerDN))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(DomainDN))),
	uintptr(fLastDcInDomain),
	uintptr(fCommit),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function DsRemoveDsServerA(
  hDs: THandle;   // HANDLE
  ServerDN: PAnsiChar;   // LPSTR
  DomainDN: PAnsiChar;   // LPSTR optional
  fLastDcInDomain: Pointer;   // BOOL* optional, out
  fCommit: BOOL   // BOOL
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsRemoveDsServerA';
result := DllCall("NTDSAPI\DsRemoveDsServerA"
    , "Ptr", hDs   ; HANDLE
    , "AStr", ServerDN   ; LPSTR
    , "AStr", DomainDN   ; LPSTR optional
    , "Ptr", fLastDcInDomain   ; BOOL* optional, out
    , "Int", fCommit   ; BOOL
    , "UInt")   ; return: DWORD
●DsRemoveDsServerA(hDs, ServerDN, DomainDN, fLastDcInDomain, fCommit) = DLL("NTDSAPI.dll", "dword DsRemoveDsServerA(void*, char*, char*, void*, bool)")
# 呼び出し: DsRemoveDsServerA(hDs, ServerDN, DomainDN, fLastDcInDomain, fCommit)
# hDs : HANDLE -> "void*"
# ServerDN : LPSTR -> "char*"
# DomainDN : LPSTR optional -> "char*"
# fLastDcInDomain : BOOL* optional, out -> "void*"
# fCommit : BOOL -> "bool"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef DsRemoveDsServerANative = Uint32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Int32>, Int32);
typedef DsRemoveDsServerADart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Pointer<Int32>, int);
final DsRemoveDsServerA = DynamicLibrary.open('NTDSAPI.dll')
    .lookupFunction<DsRemoveDsServerANative, DsRemoveDsServerADart>('DsRemoveDsServerA');
// hDs : HANDLE -> Pointer<Void>
// ServerDN : LPSTR -> Pointer<Utf8>
// DomainDN : LPSTR optional -> Pointer<Utf8>
// fLastDcInDomain : BOOL* optional, out -> Pointer<Int32>
// fCommit : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DsRemoveDsServerA(
  hDs: THandle;   // HANDLE
  ServerDN: PAnsiChar;   // LPSTR
  DomainDN: PAnsiChar;   // LPSTR optional
  fLastDcInDomain: Pointer;   // BOOL* optional, out
  fCommit: BOOL   // BOOL
): DWORD; stdcall;
  external 'NTDSAPI.dll' name 'DsRemoveDsServerA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DsRemoveDsServerA"
  c_DsRemoveDsServerA :: Ptr () -> CString -> CString -> Ptr CInt -> CInt -> IO Word32
-- hDs : HANDLE -> Ptr ()
-- ServerDN : LPSTR -> CString
-- DomainDN : LPSTR optional -> CString
-- fLastDcInDomain : BOOL* optional, out -> Ptr CInt
-- fCommit : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dsremovedsservera =
  foreign "DsRemoveDsServerA"
    ((ptr void) @-> string @-> string @-> (ptr int32_t) @-> int32_t @-> returning uint32_t)
(* hDs : HANDLE -> (ptr void) *)
(* ServerDN : LPSTR -> string *)
(* DomainDN : LPSTR optional -> string *)
(* fLastDcInDomain : BOOL* optional, out -> (ptr int32_t) *)
(* fCommit : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ntdsapi (t "NTDSAPI.dll"))
(cffi:use-foreign-library ntdsapi)

(cffi:defcfun ("DsRemoveDsServerA" ds-remove-ds-server-a :convention :stdcall) :uint32
  (h-ds :pointer)   ; HANDLE
  (server-dn :string)   ; LPSTR
  (domain-dn :string)   ; LPSTR optional
  (f-last-dc-in-domain :pointer)   ; BOOL* optional, out
  (f-commit :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DsRemoveDsServerA = Win32::API::More->new('NTDSAPI',
    'DWORD DsRemoveDsServerA(HANDLE hDs, LPCSTR ServerDN, LPCSTR DomainDN, LPVOID fLastDcInDomain, BOOL fCommit)');
# my $ret = $DsRemoveDsServerA->Call($hDs, $ServerDN, $DomainDN, $fLastDcInDomain, $fCommit);
# hDs : HANDLE -> HANDLE
# ServerDN : LPSTR -> LPCSTR
# DomainDN : LPSTR optional -> LPCSTR
# fLastDcInDomain : BOOL* optional, out -> LPVOID
# fCommit : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い