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

DhcpV4FailoverGetAddressStatus

関数
フェールオーバー構成サブネットのアドレス割当状態を取得する。
DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2012

シグネチャ

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

DWORD DhcpV4FailoverGetAddressStatus(
    LPWSTR ServerIpAddress,   // optional
    DWORD SubnetAddress,
    DWORD* pStatus
);

パラメーター

名前方向説明
ServerIpAddressLPWSTRinoptional対象DHCPサーバーのIPアドレスを示すUnicode文字列。ローカルならNULL可。
SubnetAddressDWORDinアドレス割り当て状態を調べる対象サブネットのIPアドレス(DWORD)。
pStatusDWORD*inout対象サブネットのフェールオーバーアドレス割り当て状態を受け取るDWORDへのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

DhcpV4FailoverGetAddressStatus = ctypes.windll.dhcpsapi.DhcpV4FailoverGetAddressStatus
DhcpV4FailoverGetAddressStatus.restype = wintypes.DWORD
DhcpV4FailoverGetAddressStatus.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPWSTR optional
    wintypes.DWORD,  # SubnetAddress : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pStatus : DWORD* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpV4FailoverGetAddressStatus = dhcpsapi.NewProc("DhcpV4FailoverGetAddressStatus")
)

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

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

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

let dhcpv4failovergetaddressstatus =
  foreign "DhcpV4FailoverGetAddressStatus"
    ((ptr uint16_t) @-> uint32_t @-> (ptr uint32_t) @-> returning uint32_t)
(* ServerIpAddress : LPWSTR optional -> (ptr uint16_t) *)
(* SubnetAddress : DWORD -> uint32_t *)
(* pStatus : DWORD* in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dhcpsapi (t "DHCPSAPI.dll"))
(cffi:use-foreign-library dhcpsapi)

(cffi:defcfun ("DhcpV4FailoverGetAddressStatus" dhcp-v4-failover-get-address-status :convention :stdcall) :uint32
  (server-ip-address (:string :encoding :utf-16le))   ; LPWSTR optional
  (subnet-address :uint32)   ; DWORD
  (p-status :pointer))   ; DWORD* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DhcpV4FailoverGetAddressStatus = Win32::API::More->new('DHCPSAPI',
    'DWORD DhcpV4FailoverGetAddressStatus(LPCWSTR ServerIpAddress, DWORD SubnetAddress, LPVOID pStatus)');
# my $ret = $DhcpV4FailoverGetAddressStatus->Call($ServerIpAddress, $SubnetAddress, $pStatus);
# ServerIpAddress : LPWSTR optional -> LPCWSTR
# SubnetAddress : DWORD -> DWORD
# pStatus : DWORD* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。