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

DhcpAddFilterV4

関数
DHCPv4サーバーにMACアドレスフィルターを追加する。
DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

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

DWORD DhcpAddFilterV4(
    LPCWSTR ServerIpAddress,   // optional
    DHCP_FILTER_ADD_INFO* AddFilterInfo,
    BOOL ForceFlag
);

パラメーター

名前方向説明
ServerIpAddressLPCWSTRinoptional操作対象DHCPサーバのIPアドレスまたはホスト名(Unicode)。
AddFilterInfoDHCP_FILTER_ADD_INFO*in追加するMACアドレスフィルタ情報を格納したDHCP_FILTER_ADD_INFO構造体へのポインタ。
ForceFlagBOOLin既存エントリがある場合に上書きを強制するか指定するBOOL。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

DhcpAddFilterV4 = ctypes.windll.dhcpsapi.DhcpAddFilterV4
DhcpAddFilterV4.restype = wintypes.DWORD
DhcpAddFilterV4.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPCWSTR optional
    ctypes.c_void_p,  # AddFilterInfo : DHCP_FILTER_ADD_INFO*
    wintypes.BOOL,  # ForceFlag : BOOL
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('DHCPSAPI.dll')
DhcpAddFilterV4 = Fiddle::Function.new(
  lib['DhcpAddFilterV4'],
  [
    Fiddle::TYPE_VOIDP,  # ServerIpAddress : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # AddFilterInfo : DHCP_FILTER_ADD_INFO*
    Fiddle::TYPE_INT,  # ForceFlag : BOOL
  ],
  -Fiddle::TYPE_INT)
#[link(name = "dhcpsapi")]
extern "system" {
    fn DhcpAddFilterV4(
        ServerIpAddress: *const u16,  // LPCWSTR optional
        AddFilterInfo: *mut DHCP_FILTER_ADD_INFO,  // DHCP_FILTER_ADD_INFO*
        ForceFlag: i32  // BOOL
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("DHCPSAPI.dll")]
public static extern uint DhcpAddFilterV4([MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress, IntPtr AddFilterInfo, bool ForceFlag);
"@
$api = Add-Type -MemberDefinition $sig -Name 'DHCPSAPI_DhcpAddFilterV4' -Namespace Win32 -PassThru
# $api::DhcpAddFilterV4(ServerIpAddress, AddFilterInfo, ForceFlag)
#uselib "DHCPSAPI.dll"
#func global DhcpAddFilterV4 "DhcpAddFilterV4" sptr, sptr, sptr
; DhcpAddFilterV4 ServerIpAddress, varptr(AddFilterInfo), ForceFlag   ; 戻り値は stat
; ServerIpAddress : LPCWSTR optional -> "sptr"
; AddFilterInfo : DHCP_FILTER_ADD_INFO* -> "sptr"
; ForceFlag : BOOL -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "DHCPSAPI.dll"
#cfunc global DhcpAddFilterV4 "DhcpAddFilterV4" wstr, var, int
; res = DhcpAddFilterV4(ServerIpAddress, AddFilterInfo, ForceFlag)
; ServerIpAddress : LPCWSTR optional -> "wstr"
; AddFilterInfo : DHCP_FILTER_ADD_INFO* -> "var"
; ForceFlag : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD DhcpAddFilterV4(LPCWSTR ServerIpAddress, DHCP_FILTER_ADD_INFO* AddFilterInfo, BOOL ForceFlag)
#uselib "DHCPSAPI.dll"
#cfunc global DhcpAddFilterV4 "DhcpAddFilterV4" wstr, var, int
; res = DhcpAddFilterV4(ServerIpAddress, AddFilterInfo, ForceFlag)
; ServerIpAddress : LPCWSTR optional -> "wstr"
; AddFilterInfo : DHCP_FILTER_ADD_INFO* -> "var"
; ForceFlag : BOOL -> "int"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpAddFilterV4 = dhcpsapi.NewProc("DhcpAddFilterV4")
)

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

extern "dhcpsapi" fn DhcpAddFilterV4(
    ServerIpAddress: [*c]const u16, // LPCWSTR optional
    AddFilterInfo: [*c]DHCP_FILTER_ADD_INFO, // DHCP_FILTER_ADD_INFO*
    ForceFlag: i32 // BOOL
) callconv(std.os.windows.WINAPI) u32;
proc DhcpAddFilterV4(
    ServerIpAddress: WideCString,  # LPCWSTR optional
    AddFilterInfo: ptr DHCP_FILTER_ADD_INFO,  # DHCP_FILTER_ADD_INFO*
    ForceFlag: int32  # BOOL
): uint32 {.importc: "DhcpAddFilterV4", stdcall, dynlib: "DHCPSAPI.dll".}
pragma(lib, "dhcpsapi");
extern(Windows)
uint DhcpAddFilterV4(
    const(wchar)* ServerIpAddress,   // LPCWSTR optional
    DHCP_FILTER_ADD_INFO* AddFilterInfo,   // DHCP_FILTER_ADD_INFO*
    int ForceFlag   // BOOL
);
ccall((:DhcpAddFilterV4, "DHCPSAPI.dll"), stdcall, UInt32,
      (Cwstring, Ptr{DHCP_FILTER_ADD_INFO}, Int32),
      ServerIpAddress, AddFilterInfo, ForceFlag)
# ServerIpAddress : LPCWSTR optional -> Cwstring
# AddFilterInfo : DHCP_FILTER_ADD_INFO* -> Ptr{DHCP_FILTER_ADD_INFO}
# ForceFlag : BOOL -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t DhcpAddFilterV4(
    const uint16_t* ServerIpAddress,
    void* AddFilterInfo,
    int32_t ForceFlag);
]]
local dhcpsapi = ffi.load("dhcpsapi")
-- dhcpsapi.DhcpAddFilterV4(ServerIpAddress, AddFilterInfo, ForceFlag)
-- ServerIpAddress : LPCWSTR optional
-- AddFilterInfo : DHCP_FILTER_ADD_INFO*
-- ForceFlag : BOOL
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('DHCPSAPI.dll');
const DhcpAddFilterV4 = lib.func('__stdcall', 'DhcpAddFilterV4', 'uint32_t', ['str16', 'void *', 'int32_t']);
// DhcpAddFilterV4(ServerIpAddress, AddFilterInfo, ForceFlag)
// ServerIpAddress : LPCWSTR optional -> 'str16'
// AddFilterInfo : DHCP_FILTER_ADD_INFO* -> 'void *'
// ForceFlag : BOOL -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("DHCPSAPI.dll", {
  DhcpAddFilterV4: { parameters: ["buffer", "pointer", "i32"], result: "u32" },
});
// lib.symbols.DhcpAddFilterV4(ServerIpAddress, AddFilterInfo, ForceFlag)
// ServerIpAddress : LPCWSTR optional -> "buffer"
// AddFilterInfo : DHCP_FILTER_ADD_INFO* -> "pointer"
// ForceFlag : BOOL -> "i32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t DhcpAddFilterV4(
    const uint16_t* ServerIpAddress,
    void* AddFilterInfo,
    int32_t ForceFlag);
C, "DHCPSAPI.dll");
// $ffi->DhcpAddFilterV4(ServerIpAddress, AddFilterInfo, ForceFlag);
// ServerIpAddress : LPCWSTR optional
// AddFilterInfo : DHCP_FILTER_ADD_INFO*
// ForceFlag : 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 Dhcpsapi extends StdCallLibrary {
    Dhcpsapi INSTANCE = Native.load("dhcpsapi", Dhcpsapi.class);
    int DhcpAddFilterV4(
        WString ServerIpAddress,   // LPCWSTR optional
        Pointer AddFilterInfo,   // DHCP_FILTER_ADD_INFO*
        boolean ForceFlag   // BOOL
    );
}
@[Link("dhcpsapi")]
lib LibDHCPSAPI
  fun DhcpAddFilterV4 = DhcpAddFilterV4(
    ServerIpAddress : UInt16*,   # LPCWSTR optional
    AddFilterInfo : DHCP_FILTER_ADD_INFO*,   # DHCP_FILTER_ADD_INFO*
    ForceFlag : 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 DhcpAddFilterV4Native = Uint32 Function(Pointer<Utf16>, Pointer<Void>, Int32);
typedef DhcpAddFilterV4Dart = int Function(Pointer<Utf16>, Pointer<Void>, int);
final DhcpAddFilterV4 = DynamicLibrary.open('DHCPSAPI.dll')
    .lookupFunction<DhcpAddFilterV4Native, DhcpAddFilterV4Dart>('DhcpAddFilterV4');
// ServerIpAddress : LPCWSTR optional -> Pointer<Utf16>
// AddFilterInfo : DHCP_FILTER_ADD_INFO* -> Pointer<Void>
// ForceFlag : BOOL -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DhcpAddFilterV4(
  ServerIpAddress: PWideChar;   // LPCWSTR optional
  AddFilterInfo: Pointer;   // DHCP_FILTER_ADD_INFO*
  ForceFlag: BOOL   // BOOL
): DWORD; stdcall;
  external 'DHCPSAPI.dll' name 'DhcpAddFilterV4';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DhcpAddFilterV4"
  c_DhcpAddFilterV4 :: CWString -> Ptr () -> CInt -> IO Word32
-- ServerIpAddress : LPCWSTR optional -> CWString
-- AddFilterInfo : DHCP_FILTER_ADD_INFO* -> Ptr ()
-- ForceFlag : BOOL -> CInt
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dhcpaddfilterv4 =
  foreign "DhcpAddFilterV4"
    ((ptr uint16_t) @-> (ptr void) @-> int32_t @-> returning uint32_t)
(* ServerIpAddress : LPCWSTR optional -> (ptr uint16_t) *)
(* AddFilterInfo : DHCP_FILTER_ADD_INFO* -> (ptr void) *)
(* ForceFlag : BOOL -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dhcpsapi (t "DHCPSAPI.dll"))
(cffi:use-foreign-library dhcpsapi)

(cffi:defcfun ("DhcpAddFilterV4" dhcp-add-filter-v4 :convention :stdcall) :uint32
  (server-ip-address (:string :encoding :utf-16le))   ; LPCWSTR optional
  (add-filter-info :pointer)   ; DHCP_FILTER_ADD_INFO*
  (force-flag :int32))   ; BOOL
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DhcpAddFilterV4 = Win32::API::More->new('DHCPSAPI',
    'DWORD DhcpAddFilterV4(LPCWSTR ServerIpAddress, LPVOID AddFilterInfo, BOOL ForceFlag)');
# my $ret = $DhcpAddFilterV4->Call($ServerIpAddress, $AddFilterInfo, $ForceFlag);
# ServerIpAddress : LPCWSTR optional -> LPCWSTR
# AddFilterInfo : DHCP_FILTER_ADD_INFO* -> LPVOID
# ForceFlag : BOOL -> BOOL
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型