ホーム › NetworkManagement.Dhcp › DhcpV4GetPolicyEx

DhcpV4GetPolicyEx

関数

DHCPサーバーから指定名の拡張IPv4ポリシーを取得する。

DLLDHCPSAPI.dll呼出規約winapi

シグネチャ

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

DWORD DhcpV4GetPolicyEx(
    LPWSTR ServerIpAddress,   // optional
    BOOL GlobalPolicy,
    DWORD SubnetAddress,
    LPWSTR PolicyName,
    DHCP_POLICY_EX** Policy
);

パラメーター

名前	型	方向	説明
ServerIpAddress	LPWSTR	inoptional	対象DHCPサーバーのIPアドレスを示すUnicode文字列。ローカルならNULL可。
GlobalPolicy	BOOL	in	グローバルポリシーを取得するかどうかを示すBOOL。
SubnetAddress	DWORD	in	サブネットポリシーを取得する場合の対象サブネットIPアドレス(DWORD)。グローバルなら無視される。
PolicyName	LPWSTR	in	取得するポリシーの名前を示す文字列。
Policy	DHCP_POLICY_EX**	out	取得した拡張ポリシー定義のDHCP_POLICY_EXへのポインタを受け取る二重ポインタ。使用後は解放する。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DhcpV4GetPolicyEx(
    LPWSTR ServerIpAddress,   // optional
    BOOL GlobalPolicy,
    DWORD SubnetAddress,
    LPWSTR PolicyName,
    DHCP_POLICY_EX** Policy
);

[DllImport("DHCPSAPI.dll", ExactSpelling = true)]
static extern uint DhcpV4GetPolicyEx(
    [MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress,   // LPWSTR optional
    bool GlobalPolicy,   // BOOL
    uint SubnetAddress,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string PolicyName,   // LPWSTR
    IntPtr Policy   // DHCP_POLICY_EX** out
);

<DllImport("DHCPSAPI.dll", ExactSpelling:=True)>
Public Shared Function DhcpV4GetPolicyEx(
    <MarshalAs(UnmanagedType.LPWStr)> ServerIpAddress As String,   ' LPWSTR optional
    GlobalPolicy As Boolean,   ' BOOL
    SubnetAddress As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> PolicyName As String,   ' LPWSTR
    Policy As IntPtr   ' DHCP_POLICY_EX** out
) As UInteger
End Function

' ServerIpAddress : LPWSTR optional
' GlobalPolicy : BOOL
' SubnetAddress : DWORD
' PolicyName : LPWSTR
' Policy : DHCP_POLICY_EX** out
Declare PtrSafe Function DhcpV4GetPolicyEx Lib "dhcpsapi" ( _
    ByVal ServerIpAddress As LongPtr, _
    ByVal GlobalPolicy As Long, _
    ByVal SubnetAddress As Long, _
    ByVal PolicyName As LongPtr, _
    ByVal Policy As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DhcpV4GetPolicyEx = ctypes.windll.dhcpsapi.DhcpV4GetPolicyEx
DhcpV4GetPolicyEx.restype = wintypes.DWORD
DhcpV4GetPolicyEx.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPWSTR optional
    wintypes.BOOL,  # GlobalPolicy : BOOL
    wintypes.DWORD,  # SubnetAddress : DWORD
    wintypes.LPCWSTR,  # PolicyName : LPWSTR
    ctypes.c_void_p,  # Policy : DHCP_POLICY_EX** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('DHCPSAPI.dll')
DhcpV4GetPolicyEx = Fiddle::Function.new(
  lib['DhcpV4GetPolicyEx'],
  [
    Fiddle::TYPE_VOIDP,  # ServerIpAddress : LPWSTR optional
    Fiddle::TYPE_INT,  # GlobalPolicy : BOOL
    -Fiddle::TYPE_INT,  # SubnetAddress : DWORD
    Fiddle::TYPE_VOIDP,  # PolicyName : LPWSTR
    Fiddle::TYPE_VOIDP,  # Policy : DHCP_POLICY_EX** out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "dhcpsapi")]
extern "system" {
    fn DhcpV4GetPolicyEx(
        ServerIpAddress: *mut u16,  // LPWSTR optional
        GlobalPolicy: i32,  // BOOL
        SubnetAddress: u32,  // DWORD
        PolicyName: *mut u16,  // LPWSTR
        Policy: *mut *mut DHCP_POLICY_EX  // DHCP_POLICY_EX** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("DHCPSAPI.dll")]
public static extern uint DhcpV4GetPolicyEx([MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress, bool GlobalPolicy, uint SubnetAddress, [MarshalAs(UnmanagedType.LPWStr)] string PolicyName, IntPtr Policy);
"@
$api = Add-Type -MemberDefinition $sig -Name 'DHCPSAPI_DhcpV4GetPolicyEx' -Namespace Win32 -PassThru
# $api::DhcpV4GetPolicyEx(ServerIpAddress, GlobalPolicy, SubnetAddress, PolicyName, Policy)

#uselib "DHCPSAPI.dll"
#func global DhcpV4GetPolicyEx "DhcpV4GetPolicyEx" sptr, sptr, sptr, sptr, sptr
; DhcpV4GetPolicyEx ServerIpAddress, GlobalPolicy, SubnetAddress, PolicyName, varptr(Policy)   ; 戻り値は stat
; ServerIpAddress : LPWSTR optional -> "sptr"
; GlobalPolicy : BOOL -> "sptr"
; SubnetAddress : DWORD -> "sptr"
; PolicyName : LPWSTR -> "sptr"
; Policy : DHCP_POLICY_EX** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "DHCPSAPI.dll"
#cfunc global DhcpV4GetPolicyEx "DhcpV4GetPolicyEx" wstr, int, int, wstr, var
; res = DhcpV4GetPolicyEx(ServerIpAddress, GlobalPolicy, SubnetAddress, PolicyName, Policy)
; ServerIpAddress : LPWSTR optional -> "wstr"
; GlobalPolicy : BOOL -> "int"
; SubnetAddress : DWORD -> "int"
; PolicyName : LPWSTR -> "wstr"
; Policy : DHCP_POLICY_EX** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "DHCPSAPI.dll"
#cfunc global DhcpV4GetPolicyEx "DhcpV4GetPolicyEx" wstr, int, int, wstr, sptr
; res = DhcpV4GetPolicyEx(ServerIpAddress, GlobalPolicy, SubnetAddress, PolicyName, varptr(Policy))
; ServerIpAddress : LPWSTR optional -> "wstr"
; GlobalPolicy : BOOL -> "int"
; SubnetAddress : DWORD -> "int"
; PolicyName : LPWSTR -> "wstr"
; Policy : DHCP_POLICY_EX** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; DWORD DhcpV4GetPolicyEx(LPWSTR ServerIpAddress, BOOL GlobalPolicy, DWORD SubnetAddress, LPWSTR PolicyName, DHCP_POLICY_EX** Policy)
#uselib "DHCPSAPI.dll"
#cfunc global DhcpV4GetPolicyEx "DhcpV4GetPolicyEx" wstr, int, int, wstr, var
; res = DhcpV4GetPolicyEx(ServerIpAddress, GlobalPolicy, SubnetAddress, PolicyName, Policy)
; ServerIpAddress : LPWSTR optional -> "wstr"
; GlobalPolicy : BOOL -> "int"
; SubnetAddress : DWORD -> "int"
; PolicyName : LPWSTR -> "wstr"
; Policy : DHCP_POLICY_EX** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD DhcpV4GetPolicyEx(LPWSTR ServerIpAddress, BOOL GlobalPolicy, DWORD SubnetAddress, LPWSTR PolicyName, DHCP_POLICY_EX** Policy)
#uselib "DHCPSAPI.dll"
#cfunc global DhcpV4GetPolicyEx "DhcpV4GetPolicyEx" wstr, int, int, wstr, intptr
; res = DhcpV4GetPolicyEx(ServerIpAddress, GlobalPolicy, SubnetAddress, PolicyName, varptr(Policy))
; ServerIpAddress : LPWSTR optional -> "wstr"
; GlobalPolicy : BOOL -> "int"
; SubnetAddress : DWORD -> "int"
; PolicyName : LPWSTR -> "wstr"
; Policy : DHCP_POLICY_EX** out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

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

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpV4GetPolicyEx = dhcpsapi.NewProc("DhcpV4GetPolicyEx")
)

// ServerIpAddress (LPWSTR optional), GlobalPolicy (BOOL), SubnetAddress (DWORD), PolicyName (LPWSTR), Policy (DHCP_POLICY_EX** out)
r1, _, err := procDhcpV4GetPolicyEx.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ServerIpAddress))),
	uintptr(GlobalPolicy),
	uintptr(SubnetAddress),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(PolicyName))),
	uintptr(Policy),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function DhcpV4GetPolicyEx(
  ServerIpAddress: PWideChar;   // LPWSTR optional
  GlobalPolicy: BOOL;   // BOOL
  SubnetAddress: DWORD;   // DWORD
  PolicyName: PWideChar;   // LPWSTR
  Policy: Pointer   // DHCP_POLICY_EX** out
): DWORD; stdcall;
  external 'DHCPSAPI.dll' name 'DhcpV4GetPolicyEx';

result := DllCall("DHCPSAPI\DhcpV4GetPolicyEx"
    , "WStr", ServerIpAddress   ; LPWSTR optional
    , "Int", GlobalPolicy   ; BOOL
    , "UInt", SubnetAddress   ; DWORD
    , "WStr", PolicyName   ; LPWSTR
    , "Ptr", Policy   ; DHCP_POLICY_EX** out
    , "UInt")   ; return: DWORD

●DhcpV4GetPolicyEx(ServerIpAddress, GlobalPolicy, SubnetAddress, PolicyName, Policy) = DLL("DHCPSAPI.dll", "dword DhcpV4GetPolicyEx(char*, bool, dword, char*, void*)")
# 呼び出し: DhcpV4GetPolicyEx(ServerIpAddress, GlobalPolicy, SubnetAddress, PolicyName, Policy)
# ServerIpAddress : LPWSTR optional -> "char*"
# GlobalPolicy : BOOL -> "bool"
# SubnetAddress : DWORD -> "dword"
# PolicyName : LPWSTR -> "char*"
# Policy : DHCP_POLICY_EX** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。