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

DhcpV4EnumPolicies

関数
DHCPサーバー上のIPv4ポリシーを列挙する。
DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2012

シグネチャ

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

DWORD DhcpV4EnumPolicies(
    LPWSTR ServerIpAddress,   // optional
    DWORD* ResumeHandle,
    DWORD PreferredMaximum,
    BOOL fGlobalPolicy,
    DWORD SubnetAddress,
    DHCP_POLICY_ARRAY** EnumInfo,
    DWORD* ElementsRead,
    DWORD* ElementsTotal
);

パラメーター

名前方向
ServerIpAddressLPWSTRinoptional
ResumeHandleDWORD*inout
PreferredMaximumDWORDin
fGlobalPolicyBOOLin
SubnetAddressDWORDin
EnumInfoDHCP_POLICY_ARRAY**out
ElementsReadDWORD*out
ElementsTotalDWORD*out

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DhcpV4EnumPolicies(
    LPWSTR ServerIpAddress,   // optional
    DWORD* ResumeHandle,
    DWORD PreferredMaximum,
    BOOL fGlobalPolicy,
    DWORD SubnetAddress,
    DHCP_POLICY_ARRAY** EnumInfo,
    DWORD* ElementsRead,
    DWORD* ElementsTotal
);
[DllImport("DHCPSAPI.dll", ExactSpelling = true)]
static extern uint DhcpV4EnumPolicies(
    [MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress,   // LPWSTR optional
    ref uint ResumeHandle,   // DWORD* in/out
    uint PreferredMaximum,   // DWORD
    bool fGlobalPolicy,   // BOOL
    uint SubnetAddress,   // DWORD
    IntPtr EnumInfo,   // DHCP_POLICY_ARRAY** out
    out uint ElementsRead,   // DWORD* out
    out uint ElementsTotal   // DWORD* out
);
<DllImport("DHCPSAPI.dll", ExactSpelling:=True)>
Public Shared Function DhcpV4EnumPolicies(
    <MarshalAs(UnmanagedType.LPWStr)> ServerIpAddress As String,   ' LPWSTR optional
    ByRef ResumeHandle As UInteger,   ' DWORD* in/out
    PreferredMaximum As UInteger,   ' DWORD
    fGlobalPolicy As Boolean,   ' BOOL
    SubnetAddress As UInteger,   ' DWORD
    EnumInfo As IntPtr,   ' DHCP_POLICY_ARRAY** out
    <Out> ByRef ElementsRead As UInteger,   ' DWORD* out
    <Out> ByRef ElementsTotal As UInteger   ' DWORD* out
) As UInteger
End Function
' ServerIpAddress : LPWSTR optional
' ResumeHandle : DWORD* in/out
' PreferredMaximum : DWORD
' fGlobalPolicy : BOOL
' SubnetAddress : DWORD
' EnumInfo : DHCP_POLICY_ARRAY** out
' ElementsRead : DWORD* out
' ElementsTotal : DWORD* out
Declare PtrSafe Function DhcpV4EnumPolicies Lib "dhcpsapi" ( _
    ByVal ServerIpAddress As LongPtr, _
    ByRef ResumeHandle As Long, _
    ByVal PreferredMaximum As Long, _
    ByVal fGlobalPolicy As Long, _
    ByVal SubnetAddress 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

DhcpV4EnumPolicies = ctypes.windll.dhcpsapi.DhcpV4EnumPolicies
DhcpV4EnumPolicies.restype = wintypes.DWORD
DhcpV4EnumPolicies.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPWSTR optional
    ctypes.POINTER(wintypes.DWORD),  # ResumeHandle : DWORD* in/out
    wintypes.DWORD,  # PreferredMaximum : DWORD
    wintypes.BOOL,  # fGlobalPolicy : BOOL
    wintypes.DWORD,  # SubnetAddress : DWORD
    ctypes.c_void_p,  # EnumInfo : DHCP_POLICY_ARRAY** out
    ctypes.POINTER(wintypes.DWORD),  # ElementsRead : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # ElementsTotal : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpV4EnumPolicies = dhcpsapi.NewProc("DhcpV4EnumPolicies")
)

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