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

DhcpV4FailoverGetClientInfo

関数
フェールオーバー対象のIPv4クライアントのリース情報を取得する。
DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2012

シグネチャ

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

DWORD DhcpV4FailoverGetClientInfo(
    LPWSTR ServerIpAddress,   // optional
    const DHCP_SEARCH_INFO* SearchInfo,
    DHCPV4_FAILOVER_CLIENT_INFO** ClientInfo
);

パラメーター

名前方向説明
ServerIpAddressLPWSTRinoptional対象DHCPサーバーのIPアドレスを示すUnicode文字列。ローカルならNULL可。
SearchInfoDHCP_SEARCH_INFO*in検索条件(IPアドレス・ハードウェアアドレス等)を指定するDHCP_SEARCH_INFO構造体へのポインタ。
ClientInfoDHCPV4_FAILOVER_CLIENT_INFO**out取得したフェールオーバークライアント情報のDHCPV4_FAILOVER_CLIENT_INFOへのポインタを受け取る二重ポインタ。使用後は解放する。

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD DhcpV4FailoverGetClientInfo(
    LPWSTR ServerIpAddress,   // optional
    const DHCP_SEARCH_INFO* SearchInfo,
    DHCPV4_FAILOVER_CLIENT_INFO** ClientInfo
);
[DllImport("DHCPSAPI.dll", ExactSpelling = true)]
static extern uint DhcpV4FailoverGetClientInfo(
    [MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress,   // LPWSTR optional
    IntPtr SearchInfo,   // DHCP_SEARCH_INFO*
    IntPtr ClientInfo   // DHCPV4_FAILOVER_CLIENT_INFO** out
);
<DllImport("DHCPSAPI.dll", ExactSpelling:=True)>
Public Shared Function DhcpV4FailoverGetClientInfo(
    <MarshalAs(UnmanagedType.LPWStr)> ServerIpAddress As String,   ' LPWSTR optional
    SearchInfo As IntPtr,   ' DHCP_SEARCH_INFO*
    ClientInfo As IntPtr   ' DHCPV4_FAILOVER_CLIENT_INFO** out
) As UInteger
End Function
' ServerIpAddress : LPWSTR optional
' SearchInfo : DHCP_SEARCH_INFO*
' ClientInfo : DHCPV4_FAILOVER_CLIENT_INFO** out
Declare PtrSafe Function DhcpV4FailoverGetClientInfo 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

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

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

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpV4FailoverGetClientInfo = dhcpsapi.NewProc("DhcpV4FailoverGetClientInfo")
)

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

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

typedef DhcpV4FailoverGetClientInfoNative = Uint32 Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
typedef DhcpV4FailoverGetClientInfoDart = int Function(Pointer<Utf16>, Pointer<Void>, Pointer<Void>);
final DhcpV4FailoverGetClientInfo = DynamicLibrary.open('DHCPSAPI.dll')
    .lookupFunction<DhcpV4FailoverGetClientInfoNative, DhcpV4FailoverGetClientInfoDart>('DhcpV4FailoverGetClientInfo');
// ServerIpAddress : LPWSTR optional -> Pointer<Utf16>
// SearchInfo : DHCP_SEARCH_INFO* -> Pointer<Void>
// ClientInfo : DHCPV4_FAILOVER_CLIENT_INFO** out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DhcpV4FailoverGetClientInfo(
  ServerIpAddress: PWideChar;   // LPWSTR optional
  SearchInfo: Pointer;   // DHCP_SEARCH_INFO*
  ClientInfo: Pointer   // DHCPV4_FAILOVER_CLIENT_INFO** out
): DWORD; stdcall;
  external 'DHCPSAPI.dll' name 'DhcpV4FailoverGetClientInfo';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

関連項目

使用する型