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

DhcpGetClientInfoV4

関数
DHCPサーバーからV4拡張のクライアント情報を取得する。
DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

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

DWORD DhcpGetClientInfoV4(
    LPCWSTR ServerIpAddress,   // optional
    const DHCP_SEARCH_INFO* SearchInfo,
    DHCP_CLIENT_INFO_V4** ClientInfo
);

パラメーター

名前方向説明
ServerIpAddressLPCWSTRinoptional操作対象DHCPサーバのIPアドレスまたはホスト名(Unicode)。
SearchInfoDHCP_SEARCH_INFO*in検索条件(IP/名前/MAC等)を指定するDHCP_SEARCH_INFO構造体へのポインタ。
ClientInfoDHCP_CLIENT_INFO_V4**inout取得したクライアント情報を受け取るDHCP_CLIENT_INFO_V4へのポインタ。RPC割当てで要解放。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

DhcpGetClientInfoV4 = ctypes.windll.dhcpsapi.DhcpGetClientInfoV4
DhcpGetClientInfoV4.restype = wintypes.DWORD
DhcpGetClientInfoV4.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPCWSTR optional
    ctypes.c_void_p,  # SearchInfo : DHCP_SEARCH_INFO*
    ctypes.c_void_p,  # ClientInfo : DHCP_CLIENT_INFO_V4** in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpGetClientInfoV4 = dhcpsapi.NewProc("DhcpGetClientInfoV4")
)

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

extern "dhcpsapi" fn DhcpGetClientInfoV4(
    ServerIpAddress: [*c]const u16, // LPCWSTR optional
    SearchInfo: [*c]DHCP_SEARCH_INFO, // DHCP_SEARCH_INFO*
    ClientInfo: [*c][*c]DHCP_CLIENT_INFO_V4 // DHCP_CLIENT_INFO_V4** in/out
) callconv(std.os.windows.WINAPI) u32;
proc DhcpGetClientInfoV4(
    ServerIpAddress: WideCString,  # LPCWSTR optional
    SearchInfo: ptr DHCP_SEARCH_INFO,  # DHCP_SEARCH_INFO*
    ClientInfo: ptr DHCP_CLIENT_INFO_V4  # DHCP_CLIENT_INFO_V4** in/out
): uint32 {.importc: "DhcpGetClientInfoV4", stdcall, dynlib: "DHCPSAPI.dll".}
pragma(lib, "dhcpsapi");
extern(Windows)
uint DhcpGetClientInfoV4(
    const(wchar)* ServerIpAddress,   // LPCWSTR optional
    DHCP_SEARCH_INFO* SearchInfo,   // DHCP_SEARCH_INFO*
    DHCP_CLIENT_INFO_V4** ClientInfo   // DHCP_CLIENT_INFO_V4** in/out
);
ccall((:DhcpGetClientInfoV4, "DHCPSAPI.dll"), stdcall, UInt32,
      (Cwstring, Ptr{DHCP_SEARCH_INFO}, Ptr{DHCP_CLIENT_INFO_V4}),
      ServerIpAddress, SearchInfo, ClientInfo)
# ServerIpAddress : LPCWSTR optional -> Cwstring
# SearchInfo : DHCP_SEARCH_INFO* -> Ptr{DHCP_SEARCH_INFO}
# ClientInfo : DHCP_CLIENT_INFO_V4** in/out -> Ptr{DHCP_CLIENT_INFO_V4}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t DhcpGetClientInfoV4(
    const uint16_t* ServerIpAddress,
    void* SearchInfo,
    void* ClientInfo);
]]
local dhcpsapi = ffi.load("dhcpsapi")
-- dhcpsapi.DhcpGetClientInfoV4(ServerIpAddress, SearchInfo, ClientInfo)
-- ServerIpAddress : LPCWSTR optional
-- SearchInfo : DHCP_SEARCH_INFO*
-- ClientInfo : DHCP_CLIENT_INFO_V4** in/out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('DHCPSAPI.dll');
const DhcpGetClientInfoV4 = lib.func('__stdcall', 'DhcpGetClientInfoV4', 'uint32_t', ['str16', 'void *', 'void *']);
// DhcpGetClientInfoV4(ServerIpAddress, SearchInfo, ClientInfo)
// ServerIpAddress : LPCWSTR optional -> 'str16'
// SearchInfo : DHCP_SEARCH_INFO* -> 'void *'
// ClientInfo : DHCP_CLIENT_INFO_V4** in/out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("DHCPSAPI.dll", {
  DhcpGetClientInfoV4: { parameters: ["buffer", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.DhcpGetClientInfoV4(ServerIpAddress, SearchInfo, ClientInfo)
// ServerIpAddress : LPCWSTR optional -> "buffer"
// SearchInfo : DHCP_SEARCH_INFO* -> "pointer"
// ClientInfo : DHCP_CLIENT_INFO_V4** in/out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t DhcpGetClientInfoV4(
    const uint16_t* ServerIpAddress,
    void* SearchInfo,
    void* ClientInfo);
C, "DHCPSAPI.dll");
// $ffi->DhcpGetClientInfoV4(ServerIpAddress, SearchInfo, ClientInfo);
// ServerIpAddress : LPCWSTR optional
// SearchInfo : DHCP_SEARCH_INFO*
// ClientInfo : DHCP_CLIENT_INFO_V4** 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 DhcpGetClientInfoV4(
        WString ServerIpAddress,   // LPCWSTR optional
        Pointer SearchInfo,   // DHCP_SEARCH_INFO*
        Pointer ClientInfo   // DHCP_CLIENT_INFO_V4** in/out
    );
}
@[Link("dhcpsapi")]
lib LibDHCPSAPI
  fun DhcpGetClientInfoV4 = DhcpGetClientInfoV4(
    ServerIpAddress : UInt16*,   # LPCWSTR optional
    SearchInfo : DHCP_SEARCH_INFO*,   # DHCP_SEARCH_INFO*
    ClientInfo : DHCP_CLIENT_INFO_V4**   # DHCP_CLIENT_INFO_V4** 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 DhcpGetClientInfoV4Native = Uint32 Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
typedef DhcpGetClientInfoV4Dart = int Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
final DhcpGetClientInfoV4 = DynamicLibrary.open('DHCPSAPI.dll')
    .lookupFunction<DhcpGetClientInfoV4Native, DhcpGetClientInfoV4Dart>('DhcpGetClientInfoV4');
// ServerIpAddress : LPCWSTR optional -> Pointer<Utf16>
// SearchInfo : DHCP_SEARCH_INFO* -> Pointer<Void>
// ClientInfo : DHCP_CLIENT_INFO_V4** in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DhcpGetClientInfoV4(
  ServerIpAddress: PWideChar;   // LPCWSTR optional
  SearchInfo: Pointer;   // DHCP_SEARCH_INFO*
  ClientInfo: Pointer   // DHCP_CLIENT_INFO_V4** in/out
): DWORD; stdcall;
  external 'DHCPSAPI.dll' name 'DhcpGetClientInfoV4';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

類似 API
使用する型