ホーム › NetworkManagement.Dhcp › DhcpEnumSubnetsV6

DhcpEnumSubnetsV6

関数

DHCPサーバーに構成されたIPv6サブネットの一覧を列挙する。

DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

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

DWORD DhcpEnumSubnetsV6(
    LPCWSTR ServerIpAddress,   // optional
    DWORD* ResumeHandle,
    DWORD PreferredMaximum,
    DHCPV6_IP_ARRAY** EnumInfo,
    DWORD* ElementsRead,
    DWORD* ElementsTotal
);

パラメーター

名前	型	方向	説明
ServerIpAddress	LPCWSTR	inoptional	対象DHCPv6サーバーのIPアドレスを示すUnicode文字列。ローカルならNULL可。
ResumeHandle	DWORD*	inout	列挙の再開位置ハンドルへのポインタ。初回は0を指す変数を渡す。
PreferredMaximum	DWORD	in	1回で返すサブネットデータの推奨最大バイト数。
EnumInfo	DHCPV6_IP_ARRAY**	inout	列挙結果のIPv6サブネットアドレス配列DHCPV6_IP_ARRAYへのポインタを受け取る二重ポインタ。使用後は解放する。
ElementsRead	DWORD*	inout	今回読み取られたサブネット数を受け取るDWORDへのポインタ。
ElementsTotal	DWORD*	inout	残りのサブネット総数を受け取るDWORDへのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DhcpEnumSubnetsV6(
    LPCWSTR ServerIpAddress,   // optional
    DWORD* ResumeHandle,
    DWORD PreferredMaximum,
    DHCPV6_IP_ARRAY** EnumInfo,
    DWORD* ElementsRead,
    DWORD* ElementsTotal
);

[DllImport("DHCPSAPI.dll", ExactSpelling = true)]
static extern uint DhcpEnumSubnetsV6(
    [MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress,   // LPCWSTR optional
    ref uint ResumeHandle,   // DWORD* in/out
    uint PreferredMaximum,   // DWORD
    IntPtr EnumInfo,   // DHCPV6_IP_ARRAY** in/out
    ref uint ElementsRead,   // DWORD* in/out
    ref uint ElementsTotal   // DWORD* in/out
);

<DllImport("DHCPSAPI.dll", ExactSpelling:=True)>
Public Shared Function DhcpEnumSubnetsV6(
    <MarshalAs(UnmanagedType.LPWStr)> ServerIpAddress As String,   ' LPCWSTR optional
    ByRef ResumeHandle As UInteger,   ' DWORD* in/out
    PreferredMaximum As UInteger,   ' DWORD
    EnumInfo As IntPtr,   ' DHCPV6_IP_ARRAY** in/out
    ByRef ElementsRead As UInteger,   ' DWORD* in/out
    ByRef ElementsTotal As UInteger   ' DWORD* in/out
) As UInteger
End Function

' ServerIpAddress : LPCWSTR optional
' ResumeHandle : DWORD* in/out
' PreferredMaximum : DWORD
' EnumInfo : DHCPV6_IP_ARRAY** in/out
' ElementsRead : DWORD* in/out
' ElementsTotal : DWORD* in/out
Declare PtrSafe Function DhcpEnumSubnetsV6 Lib "dhcpsapi" ( _
    ByVal ServerIpAddress As LongPtr, _
    ByRef ResumeHandle As Long, _
    ByVal PreferredMaximum As Long, _
    ByVal EnumInfo As LongPtr, _
    ByRef ElementsRead As Long, _
    ByRef ElementsTotal As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DhcpEnumSubnetsV6 = ctypes.windll.dhcpsapi.DhcpEnumSubnetsV6
DhcpEnumSubnetsV6.restype = wintypes.DWORD
DhcpEnumSubnetsV6.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPCWSTR optional
    ctypes.POINTER(wintypes.DWORD),  # ResumeHandle : DWORD* in/out
    wintypes.DWORD,  # PreferredMaximum : DWORD
    ctypes.c_void_p,  # EnumInfo : DHCPV6_IP_ARRAY** in/out
    ctypes.POINTER(wintypes.DWORD),  # ElementsRead : DWORD* in/out
    ctypes.POINTER(wintypes.DWORD),  # ElementsTotal : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('DHCPSAPI.dll')
DhcpEnumSubnetsV6 = Fiddle::Function.new(
  lib['DhcpEnumSubnetsV6'],
  [
    Fiddle::TYPE_VOIDP,  # ServerIpAddress : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # ResumeHandle : DWORD* in/out
    -Fiddle::TYPE_INT,  # PreferredMaximum : DWORD
    Fiddle::TYPE_VOIDP,  # EnumInfo : DHCPV6_IP_ARRAY** in/out
    Fiddle::TYPE_VOIDP,  # ElementsRead : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # ElementsTotal : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "dhcpsapi")]
extern "system" {
    fn DhcpEnumSubnetsV6(
        ServerIpAddress: *const u16,  // LPCWSTR optional
        ResumeHandle: *mut u32,  // DWORD* in/out
        PreferredMaximum: u32,  // DWORD
        EnumInfo: *mut *mut DHCPV6_IP_ARRAY,  // DHCPV6_IP_ARRAY** in/out
        ElementsRead: *mut u32,  // DWORD* in/out
        ElementsTotal: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("DHCPSAPI.dll")]
public static extern uint DhcpEnumSubnetsV6([MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress, ref uint ResumeHandle, uint PreferredMaximum, IntPtr EnumInfo, ref uint ElementsRead, ref uint ElementsTotal);
"@
$api = Add-Type -MemberDefinition $sig -Name 'DHCPSAPI_DhcpEnumSubnetsV6' -Namespace Win32 -PassThru
# $api::DhcpEnumSubnetsV6(ServerIpAddress, ResumeHandle, PreferredMaximum, EnumInfo, ElementsRead, ElementsTotal)

#uselib "DHCPSAPI.dll"
#func global DhcpEnumSubnetsV6 "DhcpEnumSubnetsV6" sptr, sptr, sptr, sptr, sptr, sptr
; DhcpEnumSubnetsV6 ServerIpAddress, varptr(ResumeHandle), PreferredMaximum, varptr(EnumInfo), varptr(ElementsRead), varptr(ElementsTotal)   ; 戻り値は stat
; ServerIpAddress : LPCWSTR optional -> "sptr"
; ResumeHandle : DWORD* in/out -> "sptr"
; PreferredMaximum : DWORD -> "sptr"
; EnumInfo : DHCPV6_IP_ARRAY** in/out -> "sptr"
; ElementsRead : DWORD* in/out -> "sptr"
; ElementsTotal : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "DHCPSAPI.dll"
#cfunc global DhcpEnumSubnetsV6 "DhcpEnumSubnetsV6" wstr, var, int, var, var, var
; res = DhcpEnumSubnetsV6(ServerIpAddress, ResumeHandle, PreferredMaximum, EnumInfo, ElementsRead, ElementsTotal)
; ServerIpAddress : LPCWSTR optional -> "wstr"
; ResumeHandle : DWORD* in/out -> "var"
; PreferredMaximum : DWORD -> "int"
; EnumInfo : DHCPV6_IP_ARRAY** in/out -> "var"
; ElementsRead : DWORD* in/out -> "var"
; ElementsTotal : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "DHCPSAPI.dll"
#cfunc global DhcpEnumSubnetsV6 "DhcpEnumSubnetsV6" wstr, sptr, int, sptr, sptr, sptr
; res = DhcpEnumSubnetsV6(ServerIpAddress, varptr(ResumeHandle), PreferredMaximum, varptr(EnumInfo), varptr(ElementsRead), varptr(ElementsTotal))
; ServerIpAddress : LPCWSTR optional -> "wstr"
; ResumeHandle : DWORD* in/out -> "sptr"
; PreferredMaximum : DWORD -> "int"
; EnumInfo : DHCPV6_IP_ARRAY** in/out -> "sptr"
; ElementsRead : DWORD* in/out -> "sptr"
; ElementsTotal : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; DWORD DhcpEnumSubnetsV6(LPCWSTR ServerIpAddress, DWORD* ResumeHandle, DWORD PreferredMaximum, DHCPV6_IP_ARRAY** EnumInfo, DWORD* ElementsRead, DWORD* ElementsTotal)
#uselib "DHCPSAPI.dll"
#cfunc global DhcpEnumSubnetsV6 "DhcpEnumSubnetsV6" wstr, var, int, var, var, var
; res = DhcpEnumSubnetsV6(ServerIpAddress, ResumeHandle, PreferredMaximum, EnumInfo, ElementsRead, ElementsTotal)
; ServerIpAddress : LPCWSTR optional -> "wstr"
; ResumeHandle : DWORD* in/out -> "var"
; PreferredMaximum : DWORD -> "int"
; EnumInfo : DHCPV6_IP_ARRAY** in/out -> "var"
; ElementsRead : DWORD* in/out -> "var"
; ElementsTotal : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD DhcpEnumSubnetsV6(LPCWSTR ServerIpAddress, DWORD* ResumeHandle, DWORD PreferredMaximum, DHCPV6_IP_ARRAY** EnumInfo, DWORD* ElementsRead, DWORD* ElementsTotal)
#uselib "DHCPSAPI.dll"
#cfunc global DhcpEnumSubnetsV6 "DhcpEnumSubnetsV6" wstr, intptr, int, intptr, intptr, intptr
; res = DhcpEnumSubnetsV6(ServerIpAddress, varptr(ResumeHandle), PreferredMaximum, varptr(EnumInfo), varptr(ElementsRead), varptr(ElementsTotal))
; ServerIpAddress : LPCWSTR optional -> "wstr"
; ResumeHandle : DWORD* in/out -> "intptr"
; PreferredMaximum : DWORD -> "int"
; EnumInfo : DHCPV6_IP_ARRAY** in/out -> "intptr"
; ElementsRead : DWORD* in/out -> "intptr"
; ElementsTotal : DWORD* in/out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpEnumSubnetsV6 = dhcpsapi.NewProc("DhcpEnumSubnetsV6")
)

// ServerIpAddress (LPCWSTR optional), ResumeHandle (DWORD* in/out), PreferredMaximum (DWORD), EnumInfo (DHCPV6_IP_ARRAY** in/out), ElementsRead (DWORD* in/out), ElementsTotal (DWORD* in/out)
r1, _, err := procDhcpEnumSubnetsV6.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ServerIpAddress))),
	uintptr(ResumeHandle),
	uintptr(PreferredMaximum),
	uintptr(EnumInfo),
	uintptr(ElementsRead),
	uintptr(ElementsTotal),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function DhcpEnumSubnetsV6(
  ServerIpAddress: PWideChar;   // LPCWSTR optional
  ResumeHandle: Pointer;   // DWORD* in/out
  PreferredMaximum: DWORD;   // DWORD
  EnumInfo: Pointer;   // DHCPV6_IP_ARRAY** in/out
  ElementsRead: Pointer;   // DWORD* in/out
  ElementsTotal: Pointer   // DWORD* in/out
): DWORD; stdcall;
  external 'DHCPSAPI.dll' name 'DhcpEnumSubnetsV6';

result := DllCall("DHCPSAPI\DhcpEnumSubnetsV6"
    , "WStr", ServerIpAddress   ; LPCWSTR optional
    , "Ptr", ResumeHandle   ; DWORD* in/out
    , "UInt", PreferredMaximum   ; DWORD
    , "Ptr", EnumInfo   ; DHCPV6_IP_ARRAY** in/out
    , "Ptr", ElementsRead   ; DWORD* in/out
    , "Ptr", ElementsTotal   ; DWORD* in/out
    , "UInt")   ; return: DWORD

●DhcpEnumSubnetsV6(ServerIpAddress, ResumeHandle, PreferredMaximum, EnumInfo, ElementsRead, ElementsTotal) = DLL("DHCPSAPI.dll", "dword DhcpEnumSubnetsV6(char*, void*, dword, void*, void*, void*)")
# 呼び出し: DhcpEnumSubnetsV6(ServerIpAddress, ResumeHandle, PreferredMaximum, EnumInfo, ElementsRead, ElementsTotal)
# ServerIpAddress : LPCWSTR optional -> "char*"
# ResumeHandle : DWORD* in/out -> "void*"
# PreferredMaximum : DWORD -> "dword"
# EnumInfo : DHCPV6_IP_ARRAY** in/out -> "void*"
# ElementsRead : DWORD* in/out -> "void*"
# ElementsTotal : DWORD* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。