ホーム › NetworkManagement.Dhcp › DhcpV4CreateClientInfo

DhcpV4CreateClientInfo

関数

DHCPサーバーに新しいIPv4クライアント予約情報を作成する。

DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2012

シグネチャ

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

DWORD DhcpV4CreateClientInfo(
    LPCWSTR ServerIpAddress,   // optional
    const DHCP_CLIENT_INFO_PB* ClientInfo
);

パラメーター

名前	型	方向	説明
ServerIpAddress	LPCWSTR	inoptional	DHCP サーバーの IP アドレスまたはホスト名を表す、null で終わる Unicode 文字列へのポインター。
ClientInfo	DHCP_CLIENT_INFO_PB*	in	DHCP クライアントのリースレコード情報を格納する DHCP_CLIENT_INFO_PB 構造体へのポインター。この構造体の ClientIpAddress フィールドおよび ClientHardwareAddress フィールドは必須で、その他はすべて省略可能です。

戻り値の型: DWORD

公式ドキュメント

DHCP サーバーデータベースに DHCPv4 クライアントのリースレコードを作成します。

戻り値

関数が成功した場合は、ERROR_SUCCESS を返します。

関数が失敗した場合は、次のいずれかの値、または DHCP Server Management API Error Codes のエラーコードを返します。

値	意味
ERROR_INVALID_PARAMETER	1 つ以上のパラメーターが無効です。
ERROR_ACCESS_DENIED	この呼び出しは、DHCP Administrators セキュリティグループのメンバーではないクライアントによって実行されました。
ERROR_DHCP_SUBNET_NOT_PRESENT	ClientInfo で渡された ClientIpAddress が、DHCP サーバーに構成されているどの DHCPv4 スコープとも一致しません。
ERROR_DHCP_CLIENT_EXISTS	指定された DHCP クライアントレコードは、DHCP サーバーデータベースに既に存在します。

解説(Remarks)

この関数は、サーバーに構成された ClientIpAddress に対応するスコープが存在しない場合はリースの作成を許可せず、代わりに ERROR_DHCP_SUBNET_NOT_PRESENT を返します。この関数は、IP アドレスの競合を避けるために、指定されたクライアント IP アドレスを使用不可 (または配布済み) としてマークします。このようにマークされたアドレスは、スコープのアドレス統計にも反映されます。

DhcpCreateClientInfoVQ とは異なり、この関数はリースレコードの作成時に、ClientInfo に渡された DHCP_CLIENT_INFO_PB 構造体の bClientType、AddressState、Status、ProbationEnds、QuarantineCapable の各フィールドを使用します。また、ClientInfo 内で渡された場合は、新しいリースレコードに新規フィールド PolicyName も追加します。PolicyName が DHCP サーバーまたは対応するスコープに構成されている有効なポリシーに対応しているかどうかの検証は行われません。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

DWORD DhcpV4CreateClientInfo(
    LPCWSTR ServerIpAddress,   // optional
    const DHCP_CLIENT_INFO_PB* ClientInfo
);

[DllImport("DHCPSAPI.dll", ExactSpelling = true)]
static extern uint DhcpV4CreateClientInfo(
    [MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress,   // LPCWSTR optional
    IntPtr ClientInfo   // DHCP_CLIENT_INFO_PB*
);

<DllImport("DHCPSAPI.dll", ExactSpelling:=True)>
Public Shared Function DhcpV4CreateClientInfo(
    <MarshalAs(UnmanagedType.LPWStr)> ServerIpAddress As String,   ' LPCWSTR optional
    ClientInfo As IntPtr   ' DHCP_CLIENT_INFO_PB*
) As UInteger
End Function

' ServerIpAddress : LPCWSTR optional
' ClientInfo : DHCP_CLIENT_INFO_PB*
Declare PtrSafe Function DhcpV4CreateClientInfo Lib "dhcpsapi" ( _
    ByVal ServerIpAddress 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

DhcpV4CreateClientInfo = ctypes.windll.dhcpsapi.DhcpV4CreateClientInfo
DhcpV4CreateClientInfo.restype = wintypes.DWORD
DhcpV4CreateClientInfo.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPCWSTR optional
    ctypes.c_void_p,  # ClientInfo : DHCP_CLIENT_INFO_PB*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('DHCPSAPI.dll')
DhcpV4CreateClientInfo = Fiddle::Function.new(
  lib['DhcpV4CreateClientInfo'],
  [
    Fiddle::TYPE_VOIDP,  # ServerIpAddress : LPCWSTR optional
    Fiddle::TYPE_VOIDP,  # ClientInfo : DHCP_CLIENT_INFO_PB*
  ],
  -Fiddle::TYPE_INT)

#[link(name = "dhcpsapi")]
extern "system" {
    fn DhcpV4CreateClientInfo(
        ServerIpAddress: *const u16,  // LPCWSTR optional
        ClientInfo: *const DHCP_CLIENT_INFO_PB  // DHCP_CLIENT_INFO_PB*
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("DHCPSAPI.dll")]
public static extern uint DhcpV4CreateClientInfo([MarshalAs(UnmanagedType.LPWStr)] string ServerIpAddress, IntPtr ClientInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'DHCPSAPI_DhcpV4CreateClientInfo' -Namespace Win32 -PassThru
# $api::DhcpV4CreateClientInfo(ServerIpAddress, ClientInfo)

#uselib "DHCPSAPI.dll"
#func global DhcpV4CreateClientInfo "DhcpV4CreateClientInfo" sptr, sptr
; DhcpV4CreateClientInfo ServerIpAddress, varptr(ClientInfo)   ; 戻り値は stat
; ServerIpAddress : LPCWSTR optional -> "sptr"
; ClientInfo : DHCP_CLIENT_INFO_PB* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "DHCPSAPI.dll"
#cfunc global DhcpV4CreateClientInfo "DhcpV4CreateClientInfo" wstr, var
; res = DhcpV4CreateClientInfo(ServerIpAddress, ClientInfo)
; ServerIpAddress : LPCWSTR optional -> "wstr"
; ClientInfo : DHCP_CLIENT_INFO_PB* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "DHCPSAPI.dll"
#cfunc global DhcpV4CreateClientInfo "DhcpV4CreateClientInfo" wstr, sptr
; res = DhcpV4CreateClientInfo(ServerIpAddress, varptr(ClientInfo))
; ServerIpAddress : LPCWSTR optional -> "wstr"
; ClientInfo : DHCP_CLIENT_INFO_PB* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。