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

DhcpGetSubnetInfo

関数
DHCPサーバーの指定サブネットの情報を取得する。
DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2000

シグネチャ

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

DWORD DhcpGetSubnetInfo(
    LPCWSTR ServerIpAddress,   // optional
    DWORD SubnetAddress,
    DHCP_SUBNET_INFO** SubnetInfo
);

パラメーター

名前方向説明
ServerIpAddressLPCWSTRinoptional操作対象DHCPサーバのIPアドレスまたはホスト名(Unicode)。
SubnetAddressDWORDin取得対象サブネットのネットワークアドレスをDWORDで指定する。
SubnetInfoDHCP_SUBNET_INFO**inout取得したサブネット情報を受け取るDHCP_SUBNET_INFOへのポインタ。RPCで割当てられ要解放。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DhcpGetSubnetInfo(
    LPCWSTR ServerIpAddress,   // optional
    DWORD SubnetAddress,
    DHCP_SUBNET_INFO** SubnetInfo
);
[DllImport("DHCPSAPI.dll", ExactSpelling = true)]
static extern uint DhcpGetSubnetInfo(
    [MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress,   // LPCWSTR optional
    uint SubnetAddress,   // DWORD
    IntPtr SubnetInfo   // DHCP_SUBNET_INFO** in/out
);
<DllImport("DHCPSAPI.dll", ExactSpelling:=True)>
Public Shared Function DhcpGetSubnetInfo(
    <MarshalAs(UnmanagedType.LPWStr)> ServerIpAddress As String,   ' LPCWSTR optional
    SubnetAddress As UInteger,   ' DWORD
    SubnetInfo As IntPtr   ' DHCP_SUBNET_INFO** in/out
) As UInteger
End Function
' ServerIpAddress : LPCWSTR optional
' SubnetAddress : DWORD
' SubnetInfo : DHCP_SUBNET_INFO** in/out
Declare PtrSafe Function DhcpGetSubnetInfo Lib "dhcpsapi" ( _
    ByVal ServerIpAddress As LongPtr, _
    ByVal SubnetAddress As Long, _
    ByVal SubnetInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

DhcpGetSubnetInfo = ctypes.windll.dhcpsapi.DhcpGetSubnetInfo
DhcpGetSubnetInfo.restype = wintypes.DWORD
DhcpGetSubnetInfo.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPCWSTR optional
    wintypes.DWORD,  # SubnetAddress : DWORD
    ctypes.c_void_p,  # SubnetInfo : DHCP_SUBNET_INFO** in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpGetSubnetInfo = dhcpsapi.NewProc("DhcpGetSubnetInfo")
)

// ServerIpAddress (LPCWSTR optional), SubnetAddress (DWORD), SubnetInfo (DHCP_SUBNET_INFO** in/out)
r1, _, err := procDhcpGetSubnetInfo.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(ServerIpAddress))),
	uintptr(SubnetAddress),
	uintptr(SubnetInfo),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function DhcpGetSubnetInfo(
  ServerIpAddress: PWideChar;   // LPCWSTR optional
  SubnetAddress: DWORD;   // DWORD
  SubnetInfo: Pointer   // DHCP_SUBNET_INFO** in/out
): DWORD; stdcall;
  external 'DHCPSAPI.dll' name 'DhcpGetSubnetInfo';
result := DllCall("DHCPSAPI\DhcpGetSubnetInfo"
    , "WStr", ServerIpAddress   ; LPCWSTR optional
    , "UInt", SubnetAddress   ; DWORD
    , "Ptr", SubnetInfo   ; DHCP_SUBNET_INFO** in/out
    , "UInt")   ; return: DWORD
●DhcpGetSubnetInfo(ServerIpAddress, SubnetAddress, SubnetInfo) = DLL("DHCPSAPI.dll", "dword DhcpGetSubnetInfo(char*, dword, void*)")
# 呼び出し: DhcpGetSubnetInfo(ServerIpAddress, SubnetAddress, SubnetInfo)
# ServerIpAddress : LPCWSTR optional -> "char*"
# SubnetAddress : DWORD -> "dword"
# SubnetInfo : DHCP_SUBNET_INFO** in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef DhcpGetSubnetInfoNative = Uint32 Function(Pointer<Utf16>, Uint32, Pointer<Void>);
typedef DhcpGetSubnetInfoDart = int Function(Pointer<Utf16>, int, Pointer<Void>);
final DhcpGetSubnetInfo = DynamicLibrary.open('DHCPSAPI.dll')
    .lookupFunction<DhcpGetSubnetInfoNative, DhcpGetSubnetInfoDart>('DhcpGetSubnetInfo');
// ServerIpAddress : LPCWSTR optional -> Pointer<Utf16>
// SubnetAddress : DWORD -> Uint32
// SubnetInfo : DHCP_SUBNET_INFO** in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DhcpGetSubnetInfo(
  ServerIpAddress: PWideChar;   // LPCWSTR optional
  SubnetAddress: DWORD;   // DWORD
  SubnetInfo: Pointer   // DHCP_SUBNET_INFO** in/out
): DWORD; stdcall;
  external 'DHCPSAPI.dll' name 'DhcpGetSubnetInfo';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DhcpGetSubnetInfo"
  c_DhcpGetSubnetInfo :: CWString -> Word32 -> Ptr () -> IO Word32
-- ServerIpAddress : LPCWSTR optional -> CWString
-- SubnetAddress : DWORD -> Word32
-- SubnetInfo : DHCP_SUBNET_INFO** in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

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

関連項目

使用する型