Win32 API 日本語リファレンス
ホームNetworkManagement.Dhcp › DhcpV4DeletePolicy

DhcpV4DeletePolicy

関数
DHCPサーバーから指定名のIPv4ポリシーを削除する。
DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2012

シグネチャ

// DHCPSAPI.dll
#include <windows.h>

DWORD DhcpV4DeletePolicy(
    LPWSTR ServerIpAddress,   // optional
    BOOL fGlobalPolicy,
    DWORD SubnetAddress,
    LPWSTR PolicyName
);

パラメーター

名前方向説明
ServerIpAddressLPWSTRinoptional対象DHCPサーバーのIPアドレスを示すUnicode文字列。ローカルならNULL可。
fGlobalPolicyBOOLinグローバルポリシーを削除するかどうかを示すBOOL。
SubnetAddressDWORDinサブネットポリシーを削除する場合の対象サブネットIPアドレス(DWORD)。グローバルなら無視される。
PolicyNameLPWSTRin削除するポリシーの名前を示す文字列。

戻り値の型: DWORD

各言語での呼び出し定義

// DHCPSAPI.dll
#include <windows.h>

DWORD DhcpV4DeletePolicy(
    LPWSTR ServerIpAddress,   // optional
    BOOL fGlobalPolicy,
    DWORD SubnetAddress,
    LPWSTR PolicyName
);
[DllImport("DHCPSAPI.dll", ExactSpelling = true)]
static extern uint DhcpV4DeletePolicy(
    [MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress,   // LPWSTR optional
    bool fGlobalPolicy,   // BOOL
    uint SubnetAddress,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string PolicyName   // LPWSTR
);
<DllImport("DHCPSAPI.dll", ExactSpelling:=True)>
Public Shared Function DhcpV4DeletePolicy(
    <MarshalAs(UnmanagedType.LPWStr)> ServerIpAddress As String,   ' LPWSTR optional
    fGlobalPolicy As Boolean,   ' BOOL
    SubnetAddress As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> PolicyName As String   ' LPWSTR
) As UInteger
End Function
' ServerIpAddress : LPWSTR optional
' fGlobalPolicy : BOOL
' SubnetAddress : DWORD
' PolicyName : LPWSTR
Declare PtrSafe Function DhcpV4DeletePolicy Lib "dhcpsapi" ( _
    ByVal ServerIpAddress As LongPtr, _
    ByVal fGlobalPolicy As Long, _
    ByVal SubnetAddress As Long, _
    ByVal PolicyName As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DhcpV4DeletePolicy = ctypes.windll.dhcpsapi.DhcpV4DeletePolicy
DhcpV4DeletePolicy.restype = wintypes.DWORD
DhcpV4DeletePolicy.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPWSTR optional
    wintypes.BOOL,  # fGlobalPolicy : BOOL
    wintypes.DWORD,  # SubnetAddress : DWORD
    wintypes.LPCWSTR,  # PolicyName : LPWSTR
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('DHCPSAPI.dll')
DhcpV4DeletePolicy = Fiddle::Function.new(
  lib['DhcpV4DeletePolicy'],
  [
    Fiddle::TYPE_VOIDP,  # ServerIpAddress : LPWSTR optional
    Fiddle::TYPE_INT,  # fGlobalPolicy : BOOL
    -Fiddle::TYPE_INT,  # SubnetAddress : DWORD
    Fiddle::TYPE_VOIDP,  # PolicyName : LPWSTR
  ],
  -Fiddle::TYPE_INT)
#[link(name = "dhcpsapi")]
extern "system" {
    fn DhcpV4DeletePolicy(
        ServerIpAddress: *mut u16,  // LPWSTR optional
        fGlobalPolicy: i32,  // BOOL
        SubnetAddress: u32,  // DWORD
        PolicyName: *mut u16  // LPWSTR
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("DHCPSAPI.dll")]
public static extern uint DhcpV4DeletePolicy([MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress, bool fGlobalPolicy, uint SubnetAddress, [MarshalAs(UnmanagedType.LPWStr)] string PolicyName);
"@
$api = Add-Type -MemberDefinition $sig -Name 'DHCPSAPI_DhcpV4DeletePolicy' -Namespace Win32 -PassThru
# $api::DhcpV4DeletePolicy(ServerIpAddress, fGlobalPolicy, SubnetAddress, PolicyName)
#uselib "DHCPSAPI.dll"
#func global DhcpV4DeletePolicy "DhcpV4DeletePolicy" sptr, sptr, sptr, sptr
; DhcpV4DeletePolicy ServerIpAddress, fGlobalPolicy, SubnetAddress, PolicyName   ; 戻り値は stat
; ServerIpAddress : LPWSTR optional -> "sptr"
; fGlobalPolicy : BOOL -> "sptr"
; SubnetAddress : DWORD -> "sptr"
; PolicyName : LPWSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "DHCPSAPI.dll"
#cfunc global DhcpV4DeletePolicy "DhcpV4DeletePolicy" wstr, int, int, wstr
; res = DhcpV4DeletePolicy(ServerIpAddress, fGlobalPolicy, SubnetAddress, PolicyName)
; ServerIpAddress : LPWSTR optional -> "wstr"
; fGlobalPolicy : BOOL -> "int"
; SubnetAddress : DWORD -> "int"
; PolicyName : LPWSTR -> "wstr"
; DWORD DhcpV4DeletePolicy(LPWSTR ServerIpAddress, BOOL fGlobalPolicy, DWORD SubnetAddress, LPWSTR PolicyName)
#uselib "DHCPSAPI.dll"
#cfunc global DhcpV4DeletePolicy "DhcpV4DeletePolicy" wstr, int, int, wstr
; res = DhcpV4DeletePolicy(ServerIpAddress, fGlobalPolicy, SubnetAddress, PolicyName)
; ServerIpAddress : LPWSTR optional -> "wstr"
; fGlobalPolicy : BOOL -> "int"
; SubnetAddress : DWORD -> "int"
; PolicyName : LPWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpV4DeletePolicy = dhcpsapi.NewProc("DhcpV4DeletePolicy")
)

// ServerIpAddress (LPWSTR optional), fGlobalPolicy (BOOL), SubnetAddress (DWORD), PolicyName (LPWSTR)
r1, _, err := procDhcpV4DeletePolicy.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ServerIpAddress))),
	uintptr(fGlobalPolicy),
	uintptr(SubnetAddress),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(PolicyName))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function DhcpV4DeletePolicy(
  ServerIpAddress: PWideChar;   // LPWSTR optional
  fGlobalPolicy: BOOL;   // BOOL
  SubnetAddress: DWORD;   // DWORD
  PolicyName: PWideChar   // LPWSTR
): DWORD; stdcall;
  external 'DHCPSAPI.dll' name 'DhcpV4DeletePolicy';
result := DllCall("DHCPSAPI\DhcpV4DeletePolicy"
    , "WStr", ServerIpAddress   ; LPWSTR optional
    , "Int", fGlobalPolicy   ; BOOL
    , "UInt", SubnetAddress   ; DWORD
    , "WStr", PolicyName   ; LPWSTR
    , "UInt")   ; return: DWORD
●DhcpV4DeletePolicy(ServerIpAddress, fGlobalPolicy, SubnetAddress, PolicyName) = DLL("DHCPSAPI.dll", "dword DhcpV4DeletePolicy(char*, bool, dword, char*)")
# 呼び出し: DhcpV4DeletePolicy(ServerIpAddress, fGlobalPolicy, SubnetAddress, PolicyName)
# ServerIpAddress : LPWSTR optional -> "char*"
# fGlobalPolicy : BOOL -> "bool"
# SubnetAddress : DWORD -> "dword"
# PolicyName : LPWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "dhcpsapi" fn DhcpV4DeletePolicy(
    ServerIpAddress: [*c]const u16, // LPWSTR optional
    fGlobalPolicy: i32, // BOOL
    SubnetAddress: u32, // DWORD
    PolicyName: [*c]const u16 // LPWSTR
) callconv(std.os.windows.WINAPI) u32;
proc DhcpV4DeletePolicy(
    ServerIpAddress: WideCString,  # LPWSTR optional
    fGlobalPolicy: int32,  # BOOL
    SubnetAddress: uint32,  # DWORD
    PolicyName: WideCString  # LPWSTR
): uint32 {.importc: "DhcpV4DeletePolicy", stdcall, dynlib: "DHCPSAPI.dll".}
pragma(lib, "dhcpsapi");
extern(Windows)
uint DhcpV4DeletePolicy(
    const(wchar)* ServerIpAddress,   // LPWSTR optional
    int fGlobalPolicy,   // BOOL
    uint SubnetAddress,   // DWORD
    const(wchar)* PolicyName   // LPWSTR
);
ccall((:DhcpV4DeletePolicy, "DHCPSAPI.dll"), stdcall, UInt32,
      (Cwstring, Int32, UInt32, Cwstring),
      ServerIpAddress, fGlobalPolicy, SubnetAddress, PolicyName)
# ServerIpAddress : LPWSTR optional -> Cwstring
# fGlobalPolicy : BOOL -> Int32
# SubnetAddress : DWORD -> UInt32
# PolicyName : LPWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t DhcpV4DeletePolicy(
    const uint16_t* ServerIpAddress,
    int32_t fGlobalPolicy,
    uint32_t SubnetAddress,
    const uint16_t* PolicyName);
]]
local dhcpsapi = ffi.load("dhcpsapi")
-- dhcpsapi.DhcpV4DeletePolicy(ServerIpAddress, fGlobalPolicy, SubnetAddress, PolicyName)
-- ServerIpAddress : LPWSTR optional
-- fGlobalPolicy : BOOL
-- SubnetAddress : DWORD
-- PolicyName : LPWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('DHCPSAPI.dll');
const DhcpV4DeletePolicy = lib.func('__stdcall', 'DhcpV4DeletePolicy', 'uint32_t', ['str16', 'int32_t', 'uint32_t', 'str16']);
// DhcpV4DeletePolicy(ServerIpAddress, fGlobalPolicy, SubnetAddress, PolicyName)
// ServerIpAddress : LPWSTR optional -> 'str16'
// fGlobalPolicy : BOOL -> 'int32_t'
// SubnetAddress : DWORD -> 'uint32_t'
// PolicyName : LPWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("DHCPSAPI.dll", {
  DhcpV4DeletePolicy: { parameters: ["buffer", "i32", "u32", "buffer"], result: "u32" },
});
// lib.symbols.DhcpV4DeletePolicy(ServerIpAddress, fGlobalPolicy, SubnetAddress, PolicyName)
// ServerIpAddress : LPWSTR optional -> "buffer"
// fGlobalPolicy : BOOL -> "i32"
// SubnetAddress : DWORD -> "u32"
// PolicyName : LPWSTR -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t DhcpV4DeletePolicy(
    const uint16_t* ServerIpAddress,
    int32_t fGlobalPolicy,
    uint32_t SubnetAddress,
    const uint16_t* PolicyName);
C, "DHCPSAPI.dll");
// $ffi->DhcpV4DeletePolicy(ServerIpAddress, fGlobalPolicy, SubnetAddress, PolicyName);
// ServerIpAddress : LPWSTR optional
// fGlobalPolicy : BOOL
// SubnetAddress : DWORD
// PolicyName : LPWSTR
// 構造体/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 Dhcpsapi extends StdCallLibrary {
    Dhcpsapi INSTANCE = Native.load("dhcpsapi", Dhcpsapi.class);
    int DhcpV4DeletePolicy(
        WString ServerIpAddress,   // LPWSTR optional
        boolean fGlobalPolicy,   // BOOL
        int SubnetAddress,   // DWORD
        WString PolicyName   // LPWSTR
    );
}
@[Link("dhcpsapi")]
lib LibDHCPSAPI
  fun DhcpV4DeletePolicy = DhcpV4DeletePolicy(
    ServerIpAddress : UInt16*,   # LPWSTR optional
    fGlobalPolicy : Int32,   # BOOL
    SubnetAddress : UInt32,   # DWORD
    PolicyName : UInt16*   # LPWSTR
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DhcpV4DeletePolicyNative = Uint32 Function(Pointer<Utf16>, Int32, Uint32, Pointer<Utf16>);
typedef DhcpV4DeletePolicyDart = int Function(Pointer<Utf16>, int, int, Pointer<Utf16>);
final DhcpV4DeletePolicy = DynamicLibrary.open('DHCPSAPI.dll')
    .lookupFunction<DhcpV4DeletePolicyNative, DhcpV4DeletePolicyDart>('DhcpV4DeletePolicy');
// ServerIpAddress : LPWSTR optional -> Pointer<Utf16>
// fGlobalPolicy : BOOL -> Int32
// SubnetAddress : DWORD -> Uint32
// PolicyName : LPWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DhcpV4DeletePolicy(
  ServerIpAddress: PWideChar;   // LPWSTR optional
  fGlobalPolicy: BOOL;   // BOOL
  SubnetAddress: DWORD;   // DWORD
  PolicyName: PWideChar   // LPWSTR
): DWORD; stdcall;
  external 'DHCPSAPI.dll' name 'DhcpV4DeletePolicy';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DhcpV4DeletePolicy"
  c_DhcpV4DeletePolicy :: CWString -> CInt -> Word32 -> CWString -> IO Word32
-- ServerIpAddress : LPWSTR optional -> CWString
-- fGlobalPolicy : BOOL -> CInt
-- SubnetAddress : DWORD -> Word32
-- PolicyName : LPWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dhcpv4deletepolicy =
  foreign "DhcpV4DeletePolicy"
    ((ptr uint16_t) @-> int32_t @-> uint32_t @-> (ptr uint16_t) @-> returning uint32_t)
(* ServerIpAddress : LPWSTR optional -> (ptr uint16_t) *)
(* fGlobalPolicy : BOOL -> int32_t *)
(* SubnetAddress : DWORD -> uint32_t *)
(* PolicyName : LPWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dhcpsapi (t "DHCPSAPI.dll"))
(cffi:use-foreign-library dhcpsapi)

(cffi:defcfun ("DhcpV4DeletePolicy" dhcp-v4-delete-policy :convention :stdcall) :uint32
  (server-ip-address (:string :encoding :utf-16le))   ; LPWSTR optional
  (f-global-policy :int32)   ; BOOL
  (subnet-address :uint32)   ; DWORD
  (policy-name (:string :encoding :utf-16le)))   ; LPWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DhcpV4DeletePolicy = Win32::API::More->new('DHCPSAPI',
    'DWORD DhcpV4DeletePolicy(LPCWSTR ServerIpAddress, BOOL fGlobalPolicy, DWORD SubnetAddress, LPCWSTR PolicyName)');
# my $ret = $DhcpV4DeletePolicy->Call($ServerIpAddress, $fGlobalPolicy, $SubnetAddress, $PolicyName);
# ServerIpAddress : LPWSTR optional -> LPCWSTR
# fGlobalPolicy : BOOL -> BOOL
# SubnetAddress : DWORD -> DWORD
# PolicyName : LPWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。