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

DhcpV4GetFreeIPAddress

関数
指定範囲から利用可能な空きIPv4アドレスを取得する。
DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2012

シグネチャ

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

DWORD DhcpV4GetFreeIPAddress(
    LPWSTR ServerIpAddress,   // optional
    DWORD ScopeId,
    DWORD StartIP,
    DWORD EndIP,
    DWORD NumFreeAddrReq,
    DHCP_IP_ARRAY** IPAddrList
);

パラメーター

名前方向説明
ServerIpAddressLPWSTRinoptional対象DHCPサーバーのIPアドレスを示すUnicode文字列。ローカルならNULL可。
ScopeIdDWORDin空きアドレスを探す対象スコープのID(サブネットアドレスDWORD)。
StartIPDWORDin検索範囲の開始IPアドレス(DWORD)。範囲制限なしなら0。
EndIPDWORDin検索範囲の終了IPアドレス(DWORD)。範囲制限なしなら0。
NumFreeAddrReqDWORDin取得を要求する空きIPアドレスの個数。
IPAddrListDHCP_IP_ARRAY**out取得した空きIPv4アドレス一覧のDHCP_IP_ARRAYへのポインタを受け取る二重ポインタ。使用後は解放する。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DhcpV4GetFreeIPAddress(
    LPWSTR ServerIpAddress,   // optional
    DWORD ScopeId,
    DWORD StartIP,
    DWORD EndIP,
    DWORD NumFreeAddrReq,
    DHCP_IP_ARRAY** IPAddrList
);
[DllImport("DHCPSAPI.dll", ExactSpelling = true)]
static extern uint DhcpV4GetFreeIPAddress(
    [MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress,   // LPWSTR optional
    uint ScopeId,   // DWORD
    uint StartIP,   // DWORD
    uint EndIP,   // DWORD
    uint NumFreeAddrReq,   // DWORD
    IntPtr IPAddrList   // DHCP_IP_ARRAY** out
);
<DllImport("DHCPSAPI.dll", ExactSpelling:=True)>
Public Shared Function DhcpV4GetFreeIPAddress(
    <MarshalAs(UnmanagedType.LPWStr)> ServerIpAddress As String,   ' LPWSTR optional
    ScopeId As UInteger,   ' DWORD
    StartIP As UInteger,   ' DWORD
    EndIP As UInteger,   ' DWORD
    NumFreeAddrReq As UInteger,   ' DWORD
    IPAddrList As IntPtr   ' DHCP_IP_ARRAY** out
) As UInteger
End Function
' ServerIpAddress : LPWSTR optional
' ScopeId : DWORD
' StartIP : DWORD
' EndIP : DWORD
' NumFreeAddrReq : DWORD
' IPAddrList : DHCP_IP_ARRAY** out
Declare PtrSafe Function DhcpV4GetFreeIPAddress Lib "dhcpsapi" ( _
    ByVal ServerIpAddress As LongPtr, _
    ByVal ScopeId As Long, _
    ByVal StartIP As Long, _
    ByVal EndIP As Long, _
    ByVal NumFreeAddrReq As Long, _
    ByVal IPAddrList As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DhcpV4GetFreeIPAddress = ctypes.windll.dhcpsapi.DhcpV4GetFreeIPAddress
DhcpV4GetFreeIPAddress.restype = wintypes.DWORD
DhcpV4GetFreeIPAddress.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPWSTR optional
    wintypes.DWORD,  # ScopeId : DWORD
    wintypes.DWORD,  # StartIP : DWORD
    wintypes.DWORD,  # EndIP : DWORD
    wintypes.DWORD,  # NumFreeAddrReq : DWORD
    ctypes.c_void_p,  # IPAddrList : DHCP_IP_ARRAY** out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpV4GetFreeIPAddress = dhcpsapi.NewProc("DhcpV4GetFreeIPAddress")
)

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

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

typedef DhcpV4GetFreeIPAddressNative = Uint32 Function(Pointer<Utf16>, Uint32, Uint32, Uint32, Uint32, Pointer<Void>);
typedef DhcpV4GetFreeIPAddressDart = int Function(Pointer<Utf16>, int, int, int, int, Pointer<Void>);
final DhcpV4GetFreeIPAddress = DynamicLibrary.open('DHCPSAPI.dll')
    .lookupFunction<DhcpV4GetFreeIPAddressNative, DhcpV4GetFreeIPAddressDart>('DhcpV4GetFreeIPAddress');
// ServerIpAddress : LPWSTR optional -> Pointer<Utf16>
// ScopeId : DWORD -> Uint32
// StartIP : DWORD -> Uint32
// EndIP : DWORD -> Uint32
// NumFreeAddrReq : DWORD -> Uint32
// IPAddrList : DHCP_IP_ARRAY** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DhcpV4GetFreeIPAddress(
  ServerIpAddress: PWideChar;   // LPWSTR optional
  ScopeId: DWORD;   // DWORD
  StartIP: DWORD;   // DWORD
  EndIP: DWORD;   // DWORD
  NumFreeAddrReq: DWORD;   // DWORD
  IPAddrList: Pointer   // DHCP_IP_ARRAY** out
): DWORD; stdcall;
  external 'DHCPSAPI.dll' name 'DhcpV4GetFreeIPAddress';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DhcpV4GetFreeIPAddress"
  c_DhcpV4GetFreeIPAddress :: CWString -> Word32 -> Word32 -> Word32 -> Word32 -> Ptr () -> IO Word32
-- ServerIpAddress : LPWSTR optional -> CWString
-- ScopeId : DWORD -> Word32
-- StartIP : DWORD -> Word32
-- EndIP : DWORD -> Word32
-- NumFreeAddrReq : DWORD -> Word32
-- IPAddrList : DHCP_IP_ARRAY** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dhcpv4getfreeipaddress =
  foreign "DhcpV4GetFreeIPAddress"
    ((ptr uint16_t) @-> uint32_t @-> uint32_t @-> uint32_t @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* ServerIpAddress : LPWSTR optional -> (ptr uint16_t) *)
(* ScopeId : DWORD -> uint32_t *)
(* StartIP : DWORD -> uint32_t *)
(* EndIP : DWORD -> uint32_t *)
(* NumFreeAddrReq : DWORD -> uint32_t *)
(* IPAddrList : DHCP_IP_ARRAY** out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dhcpsapi (t "DHCPSAPI.dll"))
(cffi:use-foreign-library dhcpsapi)

(cffi:defcfun ("DhcpV4GetFreeIPAddress" dhcp-v4-get-free-ipaddress :convention :stdcall) :uint32
  (server-ip-address (:string :encoding :utf-16le))   ; LPWSTR optional
  (scope-id :uint32)   ; DWORD
  (start-ip :uint32)   ; DWORD
  (end-ip :uint32)   ; DWORD
  (num-free-addr-req :uint32)   ; DWORD
  (ipaddr-list :pointer))   ; DHCP_IP_ARRAY** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DhcpV4GetFreeIPAddress = Win32::API::More->new('DHCPSAPI',
    'DWORD DhcpV4GetFreeIPAddress(LPCWSTR ServerIpAddress, DWORD ScopeId, DWORD StartIP, DWORD EndIP, DWORD NumFreeAddrReq, LPVOID IPAddrList)');
# my $ret = $DhcpV4GetFreeIPAddress->Call($ServerIpAddress, $ScopeId, $StartIP, $EndIP, $NumFreeAddrReq, $IPAddrList);
# ServerIpAddress : LPWSTR optional -> LPCWSTR
# ScopeId : DWORD -> DWORD
# StartIP : DWORD -> DWORD
# EndIP : DWORD -> DWORD
# NumFreeAddrReq : DWORD -> DWORD
# IPAddrList : DHCP_IP_ARRAY** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型