ホーム › NetworkManagement.Dhcp › DhcpHlprAddV4PolicyCondition

DhcpHlprAddV4PolicyCondition

関数

IPv4 DHCPポリシーに条件式を追加するヘルパー関数。

DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2012

シグネチャ

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

DWORD DhcpHlprAddV4PolicyCondition(
    DHCP_POLICY* Policy,
    DWORD ParentExpr,
    DHCP_POL_ATTR_TYPE Type,
    DWORD OptionID,
    DWORD SubOptionID,
    LPWSTR VendorName,   // optional
    DHCP_POL_COMPARATOR Operator,
    BYTE* Value,
    DWORD ValueLength,
    DWORD* ConditionIndex
);

パラメーター

名前	型	方向	説明
Policy	DHCP_POLICY*	inout	条件を追加する対象のDHCP_POLICY構造体へのポインタ。
ParentExpr	DWORD	in	条件をぶら下げる親式のインデックス。
Type	DHCP_POL_ATTR_TYPE	in	条件で参照する属性の種別を指定するDHCP_POL_ATTR_TYPE列挙値(オプション・サブオプション・ハードウェアアドレス等)。
OptionID	DWORD	in	条件評価に用いるオプションの識別子。
SubOptionID	DWORD	in	条件評価に用いるサブオプションの識別子。該当なしなら0。
VendorName	LPWSTR	inoptional	ベンダー固有オプションを参照する場合のベンダー名。標準ならNULL可。
Operator	DHCP_POL_COMPARATOR	in	値の比較方法を指定するDHCP_POL_COMPARATOR列挙値(等しい・含む等)。
Value	BYTE*	in	比較対象の値を格納したバイト配列へのポインタ。
ValueLength	DWORD	in	Valueバッファのバイト長。
ConditionIndex	DWORD*	out	追加された条件のインデックスを受け取るDWORDへのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DhcpHlprAddV4PolicyCondition(
    DHCP_POLICY* Policy,
    DWORD ParentExpr,
    DHCP_POL_ATTR_TYPE Type,
    DWORD OptionID,
    DWORD SubOptionID,
    LPWSTR VendorName,   // optional
    DHCP_POL_COMPARATOR Operator,
    BYTE* Value,
    DWORD ValueLength,
    DWORD* ConditionIndex
);

[DllImport("DHCPSAPI.dll", ExactSpelling = true)]
static extern uint DhcpHlprAddV4PolicyCondition(
    IntPtr Policy,   // DHCP_POLICY* in/out
    uint ParentExpr,   // DWORD
    int Type,   // DHCP_POL_ATTR_TYPE
    uint OptionID,   // DWORD
    uint SubOptionID,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string VendorName,   // LPWSTR optional
    int Operator,   // DHCP_POL_COMPARATOR
    IntPtr Value,   // BYTE*
    uint ValueLength,   // DWORD
    out uint ConditionIndex   // DWORD* out
);

<DllImport("DHCPSAPI.dll", ExactSpelling:=True)>
Public Shared Function DhcpHlprAddV4PolicyCondition(
    Policy As IntPtr,   ' DHCP_POLICY* in/out
    ParentExpr As UInteger,   ' DWORD
    Type As Integer,   ' DHCP_POL_ATTR_TYPE
    OptionID As UInteger,   ' DWORD
    SubOptionID As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> VendorName As String,   ' LPWSTR optional
    [Operator] As Integer,   ' DHCP_POL_COMPARATOR
    Value As IntPtr,   ' BYTE*
    ValueLength As UInteger,   ' DWORD
    <Out> ByRef ConditionIndex As UInteger   ' DWORD* out
) As UInteger
End Function

' Policy : DHCP_POLICY* in/out
' ParentExpr : DWORD
' Type : DHCP_POL_ATTR_TYPE
' OptionID : DWORD
' SubOptionID : DWORD
' VendorName : LPWSTR optional
' Operator : DHCP_POL_COMPARATOR
' Value : BYTE*
' ValueLength : DWORD
' ConditionIndex : DWORD* out
Declare PtrSafe Function DhcpHlprAddV4PolicyCondition Lib "dhcpsapi" ( _
    ByVal Policy As LongPtr, _
    ByVal ParentExpr As Long, _
    ByVal Type As Long, _
    ByVal OptionID As Long, _
    ByVal SubOptionID As Long, _
    ByVal VendorName As LongPtr, _
    ByVal Operator As Long, _
    ByVal Value As LongPtr, _
    ByVal ValueLength As Long, _
    ByRef ConditionIndex As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DhcpHlprAddV4PolicyCondition = ctypes.windll.dhcpsapi.DhcpHlprAddV4PolicyCondition
DhcpHlprAddV4PolicyCondition.restype = wintypes.DWORD
DhcpHlprAddV4PolicyCondition.argtypes = [
    ctypes.c_void_p,  # Policy : DHCP_POLICY* in/out
    wintypes.DWORD,  # ParentExpr : DWORD
    ctypes.c_int,  # Type : DHCP_POL_ATTR_TYPE
    wintypes.DWORD,  # OptionID : DWORD
    wintypes.DWORD,  # SubOptionID : DWORD
    wintypes.LPCWSTR,  # VendorName : LPWSTR optional
    ctypes.c_int,  # Operator : DHCP_POL_COMPARATOR
    ctypes.POINTER(ctypes.c_ubyte),  # Value : BYTE*
    wintypes.DWORD,  # ValueLength : DWORD
    ctypes.POINTER(wintypes.DWORD),  # ConditionIndex : DWORD* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('DHCPSAPI.dll')
DhcpHlprAddV4PolicyCondition = Fiddle::Function.new(
  lib['DhcpHlprAddV4PolicyCondition'],
  [
    Fiddle::TYPE_VOIDP,  # Policy : DHCP_POLICY* in/out
    -Fiddle::TYPE_INT,  # ParentExpr : DWORD
    Fiddle::TYPE_INT,  # Type : DHCP_POL_ATTR_TYPE
    -Fiddle::TYPE_INT,  # OptionID : DWORD
    -Fiddle::TYPE_INT,  # SubOptionID : DWORD
    Fiddle::TYPE_VOIDP,  # VendorName : LPWSTR optional
    Fiddle::TYPE_INT,  # Operator : DHCP_POL_COMPARATOR
    Fiddle::TYPE_VOIDP,  # Value : BYTE*
    -Fiddle::TYPE_INT,  # ValueLength : DWORD
    Fiddle::TYPE_VOIDP,  # ConditionIndex : DWORD* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "dhcpsapi")]
extern "system" {
    fn DhcpHlprAddV4PolicyCondition(
        Policy: *mut DHCP_POLICY,  // DHCP_POLICY* in/out
        ParentExpr: u32,  // DWORD
        Type: i32,  // DHCP_POL_ATTR_TYPE
        OptionID: u32,  // DWORD
        SubOptionID: u32,  // DWORD
        VendorName: *mut u16,  // LPWSTR optional
        Operator: i32,  // DHCP_POL_COMPARATOR
        Value: *mut u8,  // BYTE*
        ValueLength: u32,  // DWORD
        ConditionIndex: *mut u32  // DWORD* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("DHCPSAPI.dll")]
public static extern uint DhcpHlprAddV4PolicyCondition(IntPtr Policy, uint ParentExpr, int Type, uint OptionID, uint SubOptionID, [MarshalAs(UnmanagedType.LPWStr)] string VendorName, int Operator, IntPtr Value, uint ValueLength, out uint ConditionIndex);
"@
$api = Add-Type -MemberDefinition $sig -Name 'DHCPSAPI_DhcpHlprAddV4PolicyCondition' -Namespace Win32 -PassThru
# $api::DhcpHlprAddV4PolicyCondition(Policy, ParentExpr, Type, OptionID, SubOptionID, VendorName, Operator, Value, ValueLength, ConditionIndex)

#uselib "DHCPSAPI.dll"
#func global DhcpHlprAddV4PolicyCondition "DhcpHlprAddV4PolicyCondition" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; DhcpHlprAddV4PolicyCondition varptr(Policy), ParentExpr, Type, OptionID, SubOptionID, VendorName, Operator, varptr(Value), ValueLength, varptr(ConditionIndex)   ; 戻り値は stat
; Policy : DHCP_POLICY* in/out -> "sptr"
; ParentExpr : DWORD -> "sptr"
; Type : DHCP_POL_ATTR_TYPE -> "sptr"
; OptionID : DWORD -> "sptr"
; SubOptionID : DWORD -> "sptr"
; VendorName : LPWSTR optional -> "sptr"
; Operator : DHCP_POL_COMPARATOR -> "sptr"
; Value : BYTE* -> "sptr"
; ValueLength : DWORD -> "sptr"
; ConditionIndex : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "DHCPSAPI.dll"
#cfunc global DhcpHlprAddV4PolicyCondition "DhcpHlprAddV4PolicyCondition" var, int, int, int, int, wstr, int, var, int, var
; res = DhcpHlprAddV4PolicyCondition(Policy, ParentExpr, Type, OptionID, SubOptionID, VendorName, Operator, Value, ValueLength, ConditionIndex)
; Policy : DHCP_POLICY* in/out -> "var"
; ParentExpr : DWORD -> "int"
; Type : DHCP_POL_ATTR_TYPE -> "int"
; OptionID : DWORD -> "int"
; SubOptionID : DWORD -> "int"
; VendorName : LPWSTR optional -> "wstr"
; Operator : DHCP_POL_COMPARATOR -> "int"
; Value : BYTE* -> "var"
; ValueLength : DWORD -> "int"
; ConditionIndex : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "DHCPSAPI.dll"
#cfunc global DhcpHlprAddV4PolicyCondition "DhcpHlprAddV4PolicyCondition" sptr, int, int, int, int, wstr, int, sptr, int, sptr
; res = DhcpHlprAddV4PolicyCondition(varptr(Policy), ParentExpr, Type, OptionID, SubOptionID, VendorName, Operator, varptr(Value), ValueLength, varptr(ConditionIndex))
; Policy : DHCP_POLICY* in/out -> "sptr"
; ParentExpr : DWORD -> "int"
; Type : DHCP_POL_ATTR_TYPE -> "int"
; OptionID : DWORD -> "int"
; SubOptionID : DWORD -> "int"
; VendorName : LPWSTR optional -> "wstr"
; Operator : DHCP_POL_COMPARATOR -> "int"
; Value : BYTE* -> "sptr"
; ValueLength : DWORD -> "int"
; ConditionIndex : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; DWORD DhcpHlprAddV4PolicyCondition(DHCP_POLICY* Policy, DWORD ParentExpr, DHCP_POL_ATTR_TYPE Type, DWORD OptionID, DWORD SubOptionID, LPWSTR VendorName, DHCP_POL_COMPARATOR Operator, BYTE* Value, DWORD ValueLength, DWORD* ConditionIndex)
#uselib "DHCPSAPI.dll"
#cfunc global DhcpHlprAddV4PolicyCondition "DhcpHlprAddV4PolicyCondition" var, int, int, int, int, wstr, int, var, int, var
; res = DhcpHlprAddV4PolicyCondition(Policy, ParentExpr, Type, OptionID, SubOptionID, VendorName, Operator, Value, ValueLength, ConditionIndex)
; Policy : DHCP_POLICY* in/out -> "var"
; ParentExpr : DWORD -> "int"
; Type : DHCP_POL_ATTR_TYPE -> "int"
; OptionID : DWORD -> "int"
; SubOptionID : DWORD -> "int"
; VendorName : LPWSTR optional -> "wstr"
; Operator : DHCP_POL_COMPARATOR -> "int"
; Value : BYTE* -> "var"
; ValueLength : DWORD -> "int"
; ConditionIndex : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD DhcpHlprAddV4PolicyCondition(DHCP_POLICY* Policy, DWORD ParentExpr, DHCP_POL_ATTR_TYPE Type, DWORD OptionID, DWORD SubOptionID, LPWSTR VendorName, DHCP_POL_COMPARATOR Operator, BYTE* Value, DWORD ValueLength, DWORD* ConditionIndex)
#uselib "DHCPSAPI.dll"
#cfunc global DhcpHlprAddV4PolicyCondition "DhcpHlprAddV4PolicyCondition" intptr, int, int, int, int, wstr, int, intptr, int, intptr
; res = DhcpHlprAddV4PolicyCondition(varptr(Policy), ParentExpr, Type, OptionID, SubOptionID, VendorName, Operator, varptr(Value), ValueLength, varptr(ConditionIndex))
; Policy : DHCP_POLICY* in/out -> "intptr"
; ParentExpr : DWORD -> "int"
; Type : DHCP_POL_ATTR_TYPE -> "int"
; OptionID : DWORD -> "int"
; SubOptionID : DWORD -> "int"
; VendorName : LPWSTR optional -> "wstr"
; Operator : DHCP_POL_COMPARATOR -> "int"
; Value : BYTE* -> "intptr"
; ValueLength : DWORD -> "int"
; ConditionIndex : DWORD* out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

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

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpHlprAddV4PolicyCondition = dhcpsapi.NewProc("DhcpHlprAddV4PolicyCondition")
)

// Policy (DHCP_POLICY* in/out), ParentExpr (DWORD), Type (DHCP_POL_ATTR_TYPE), OptionID (DWORD), SubOptionID (DWORD), VendorName (LPWSTR optional), Operator (DHCP_POL_COMPARATOR), Value (BYTE*), ValueLength (DWORD), ConditionIndex (DWORD* out)
r1, _, err := procDhcpHlprAddV4PolicyCondition.Call(
	uintptr(Policy),
	uintptr(ParentExpr),
	uintptr(Type),
	uintptr(OptionID),
	uintptr(SubOptionID),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(VendorName))),
	uintptr(Operator),
	uintptr(Value),
	uintptr(ValueLength),
	uintptr(ConditionIndex),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function DhcpHlprAddV4PolicyCondition(
  Policy: Pointer;   // DHCP_POLICY* in/out
  ParentExpr: DWORD;   // DWORD
  Type: Integer;   // DHCP_POL_ATTR_TYPE
  OptionID: DWORD;   // DWORD
  SubOptionID: DWORD;   // DWORD
  VendorName: PWideChar;   // LPWSTR optional
  Operator: Integer;   // DHCP_POL_COMPARATOR
  Value: Pointer;   // BYTE*
  ValueLength: DWORD;   // DWORD
  ConditionIndex: Pointer   // DWORD* out
): DWORD; stdcall;
  external 'DHCPSAPI.dll' name 'DhcpHlprAddV4PolicyCondition';

result := DllCall("DHCPSAPI\DhcpHlprAddV4PolicyCondition"
    , "Ptr", Policy   ; DHCP_POLICY* in/out
    , "UInt", ParentExpr   ; DWORD
    , "Int", Type   ; DHCP_POL_ATTR_TYPE
    , "UInt", OptionID   ; DWORD
    , "UInt", SubOptionID   ; DWORD
    , "WStr", VendorName   ; LPWSTR optional
    , "Int", Operator   ; DHCP_POL_COMPARATOR
    , "Ptr", Value   ; BYTE*
    , "UInt", ValueLength   ; DWORD
    , "Ptr", ConditionIndex   ; DWORD* out
    , "UInt")   ; return: DWORD

●DhcpHlprAddV4PolicyCondition(Policy, ParentExpr, Type, OptionID, SubOptionID, VendorName, Operator, Value, ValueLength, ConditionIndex) = DLL("DHCPSAPI.dll", "dword DhcpHlprAddV4PolicyCondition(void*, dword, int, dword, dword, char*, int, void*, dword, void*)")
# 呼び出し: DhcpHlprAddV4PolicyCondition(Policy, ParentExpr, Type, OptionID, SubOptionID, VendorName, Operator, Value, ValueLength, ConditionIndex)
# Policy : DHCP_POLICY* in/out -> "void*"
# ParentExpr : DWORD -> "dword"
# Type : DHCP_POL_ATTR_TYPE -> "int"
# OptionID : DWORD -> "dword"
# SubOptionID : DWORD -> "dword"
# VendorName : LPWSTR optional -> "char*"
# Operator : DHCP_POL_COMPARATOR -> "int"
# Value : BYTE* -> "void*"
# ValueLength : DWORD -> "dword"
# ConditionIndex : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。