Win32 API 日本語リファレンス
ホーム › 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
);

パラメーター

名前型方向説明
ServerIpAddressLPWSTRinoptional対象DHCPサーバーのIPアドレスを示すUnicode文字列。ローカルならNULL可。
GlobalPolicyBOOLinグローバルポリシーを取得するかどうかを示すBOOL。
SubnetAddressDWORDinサブネットポリシーを取得する場合の対象サブネットIPアドレス(DWORD)。グローバルなら無視される。
PolicyNameLPWSTRin取得するポリシーの名前を示す文字列。
PolicyDHCP_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 方式にも切替可。
出力引数: 
; 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 方式にも切替可。
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)。
const std = @import("std");

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

typedef DhcpV4GetPolicyExNative = Uint32 Function(Pointer<Utf16>, Int32, Uint32, Pointer<Utf16>, Pointer<Void>);
typedef DhcpV4GetPolicyExDart = int Function(Pointer<Utf16>, int, int, Pointer<Utf16>, Pointer<Void>);
final DhcpV4GetPolicyEx = DynamicLibrary.open('DHCPSAPI.dll')
    .lookupFunction<DhcpV4GetPolicyExNative, DhcpV4GetPolicyExDart>('DhcpV4GetPolicyEx');
// ServerIpAddress : LPWSTR optional -> Pointer<Utf16>
// GlobalPolicy : BOOL -> Int32
// SubnetAddress : DWORD -> Uint32
// PolicyName : LPWSTR -> Pointer<Utf16>
// Policy : DHCP_POLICY_EX** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DhcpV4GetPolicyEx"
  c_DhcpV4GetPolicyEx :: CWString -> CInt -> Word32 -> CWString -> Ptr () -> IO Word32
-- ServerIpAddress : LPWSTR optional -> CWString
-- GlobalPolicy : BOOL -> CInt
-- SubnetAddress : DWORD -> Word32
-- PolicyName : LPWSTR -> CWString
-- Policy : DHCP_POLICY_EX** out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dhcpv4getpolicyex =
  foreign "DhcpV4GetPolicyEx"
    ((ptr uint16_t) @-> int32_t @-> uint32_t @-> (ptr uint16_t) @-> (ptr void) @-> returning uint32_t)
(* ServerIpAddress : LPWSTR optional -> (ptr uint16_t) *)
(* GlobalPolicy : BOOL -> int32_t *)
(* SubnetAddress : DWORD -> uint32_t *)
(* PolicyName : LPWSTR -> (ptr uint16_t) *)
(* Policy : DHCP_POLICY_EX** 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 ("DhcpV4GetPolicyEx" dhcp-v4-get-policy-ex :convention :stdcall) :uint32
  (server-ip-address (:string :encoding :utf-16le))   ; LPWSTR optional
  (global-policy :int32)   ; BOOL
  (subnet-address :uint32)   ; DWORD
  (policy-name (:string :encoding :utf-16le))   ; LPWSTR
  (policy :pointer))   ; DHCP_POLICY_EX** out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DhcpV4GetPolicyEx = Win32::API::More->new('DHCPSAPI',
    'DWORD DhcpV4GetPolicyEx(LPCWSTR ServerIpAddress, BOOL GlobalPolicy, DWORD SubnetAddress, LPCWSTR PolicyName, LPVOID Policy)');
# my $ret = $DhcpV4GetPolicyEx->Call($ServerIpAddress, $GlobalPolicy, $SubnetAddress, $PolicyName, $Policy);
# ServerIpAddress : LPWSTR optional -> LPCWSTR
# GlobalPolicy : BOOL -> BOOL
# SubnetAddress : DWORD -> DWORD
# PolicyName : LPWSTR -> LPCWSTR
# Policy : DHCP_POLICY_EX** out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型