ホーム › NetworkManagement.Dhcp › DhcpRequestParams

DhcpRequestParams

関数

DHCPサーバーから指定オプションパラメータを要求し取得する。

DLLdhcpcsvc.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD DhcpRequestParams(
    DWORD Flags,
    void* Reserved,
    LPWSTR AdapterName,
    DHCPCAPI_CLASSID* ClassId,
    DHCPCAPI_PARAMS_ARRAY SendParams,
    DHCPCAPI_PARAMS_ARRAY RecdParams,
    BYTE* Buffer,
    DWORD* pSize,
    LPWSTR RequestIdStr
);

パラメーター

名前

型

方向

説明

Flags

DWORD

要求するデータを指定するフラグです。このパラメーターは省略可能です。次の値がサポートされており、これらは相互排他的ではありません。

値	意味
DHCPCAPI_REQUEST_PERSISTENT	要求は永続化されますが、オプションの取得は行われません。
DHCPCAPI_REQUEST_SYNCHRONOUS	オプションがサーバーから取得されます。

Reserved

void*

inout

将来の使用のために予約されています。NULL を設定する必要があります。

AdapterName

LPWSTR

データの要求先となるアダプターの GUID です。256 文字未満である必要があります。

ClassId

DHCPCAPI_CLASSID*

inout

DHCP INFORM メッセージをネットワークへ送信する場合に使用するクラス識別子 (ID) です。このパラメーターは省略可能です。

SendParams

DHCPCAPI_PARAMS_ARRAY

RecdParams 配列で要求するデータに加えて要求する、省略可能なデータです。SendParams パラメーターには、DHCP クライアントが既定で送信する標準オプションを含めることはできません。

RecdParams

DHCPCAPI_PARAMS_ARRAY

呼び出し元が受信を希望する DHCP データの配列です。この配列は、 DhcpRequestParams 関数を呼び出す前は空である必要があります。

Buffer

BYTE*

out

RecdParams で行った要求に関連付けられたデータを格納するために使用するバッファーです。

pSize

DWORD*

inout

Buffer のサイズです。

バッファーがデータを保持するのに十分な大きさでない場合は、必要なバッファーのサイズが格納されます。それ以外の場合は、正常に格納されたバッファーのサイズを示します。

RequestIdStr

LPWSTR

永続的な要求を行うために使用するアプリケーション識別子 (ID) です。特殊文字を含まない印刷可能な文字列である必要があります (コンマ、バックスラッシュ、コロンなどの使用できない文字は指定できません)。指定したアプリケーション識別子 (ID) は、必要に応じて永続的な要求を解除するために、後続の DhcpUndoRequestParams 関数の呼び出しで使用されます。

戻り値の型: DWORD

公式ドキュメント

DhcpRequestParams 関数は、呼び出し元が DHCP サーバーから DHCP データを同期的に、または同期的かつ永続的に取得できるようにします。

戻り値

正常に完了した場合は ERROR_SUCCESS を返します。

戻り時には、RecdParams に要求したデータへのポインターが設定され、対応するデータが Buffer に配置されます。pSize が、返されるデータを格納するのに Buffer の領域が不足していることを示している場合、 DhcpRequestParams 関数は ERROR_MORE_DATA を返し、必要なバッファーサイズを pSize に返します。なお、最初の関数呼び出しが戻ってから後続の呼び出しを行うまでの間に、Buffer に必要なサイズが増加する場合があります。そのため、(pSize に示される) Buffer の必要サイズは、Buffer に必要となるおおよそのサイズの目安であり、pSize が示すサイズに Buffer を設定すれば後続の呼び出しが必ず成功することを保証するものではありません。

その他のエラーの場合は、対応する Windows エラーコードが返されます。

戻り値	説明
ERROR_INVALID_PARAMETER	AdapterName パラメーターの長さが 256 文字を超える場合に返されます。
ERROR_BUFFER_OVERFLOW	AdapterName パラメーターの長さが 256 文字を超える場合に返されます。

解説(Remarks)

DHCP クライアントは、DHCP サーバーから取得したデータをローカルキャッシュに保存します。 DhcpRequestParams 関数呼び出しの RecdParams 配列で要求されたすべてのデータが DHCP クライアントのキャッシュに存在する場合、クライアントはキャッシュからデータを返します。要求されたデータがクライアントのキャッシュにない場合、クライアントは DHCP サーバーへ DHCP-INFORM メッセージを送信することで DhcpRequestParams 関数の呼び出しを処理します。

クライアントは、DHCP サーバーへ DHCP-INFORM メッセージを送信する際に、省略可能な SendParams パラメーターで指定された要求を含め、ClassId パラメーターにクラス識別子 (ID) が指定されている場合はそれを提示します。

また、クライアントは DHCP クライアントが起動するたびに DHCP サーバーから DHCP データを取得するよう指定することもできます。これは永続的な要求と見なされます。永続的な要求を有効にするには、呼び出し元は RequestIdStr パラメーターを指定し、さらに dwFlags パラメーターに DHCPAPI_REQUEST_PERSISTENT フラグを追加で指定する必要があります。この永続的な要求の機能は、起動のたびにアプリケーションにとって重要な情報を自動的に要求する必要がある場合に特に有用です。永続的な要求を無効にするには、クライアントは関数を呼び出す必要があります。

メモこの API は、コードまたは状態を返すまでに最大 2 分かかることがあるため、呼び出し元はこの API をブロッキング呼び出しとして使用しないでください。特に UI の動作では、この呼び出しの戻りを待ってブロックしないでください。UI の応答時間に大幅な遅延が生じる可能性があります。

DHCP INFORM メッセージの詳細や、DHCP に関するその他の標準仕様に基づく情報については、 DHCP Standards を参照してください。

DhcpRequestParams 関数の使用例については、 DHCP Examples を参照してください。

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

各言語での呼び出し定義

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

DWORD DhcpRequestParams(
    DWORD Flags,
    void* Reserved,
    LPWSTR AdapterName,
    DHCPCAPI_CLASSID* ClassId,
    DHCPCAPI_PARAMS_ARRAY SendParams,
    DHCPCAPI_PARAMS_ARRAY RecdParams,
    BYTE* Buffer,
    DWORD* pSize,
    LPWSTR RequestIdStr
);

[DllImport("dhcpcsvc.dll", ExactSpelling = true)]
static extern uint DhcpRequestParams(
    uint Flags,   // DWORD
    IntPtr Reserved,   // void* in/out
    [MarshalAs(UnmanagedType.LPWStr)] string AdapterName,   // LPWSTR
    IntPtr ClassId,   // DHCPCAPI_CLASSID* in/out
    DHCPCAPI_PARAMS_ARRAY SendParams,   // DHCPCAPI_PARAMS_ARRAY
    DHCPCAPI_PARAMS_ARRAY RecdParams,   // DHCPCAPI_PARAMS_ARRAY
    IntPtr Buffer,   // BYTE* out
    ref uint pSize,   // DWORD* in/out
    [MarshalAs(UnmanagedType.LPWStr)] string RequestIdStr   // LPWSTR
);

<DllImport("dhcpcsvc.dll", ExactSpelling:=True)>
Public Shared Function DhcpRequestParams(
    Flags As UInteger,   ' DWORD
    Reserved As IntPtr,   ' void* in/out
    <MarshalAs(UnmanagedType.LPWStr)> AdapterName As String,   ' LPWSTR
    ClassId As IntPtr,   ' DHCPCAPI_CLASSID* in/out
    SendParams As DHCPCAPI_PARAMS_ARRAY,   ' DHCPCAPI_PARAMS_ARRAY
    RecdParams As DHCPCAPI_PARAMS_ARRAY,   ' DHCPCAPI_PARAMS_ARRAY
    Buffer As IntPtr,   ' BYTE* out
    ByRef pSize As UInteger,   ' DWORD* in/out
    <MarshalAs(UnmanagedType.LPWStr)> RequestIdStr As String   ' LPWSTR
) As UInteger
End Function

' Flags : DWORD
' Reserved : void* in/out
' AdapterName : LPWSTR
' ClassId : DHCPCAPI_CLASSID* in/out
' SendParams : DHCPCAPI_PARAMS_ARRAY
' RecdParams : DHCPCAPI_PARAMS_ARRAY
' Buffer : BYTE* out
' pSize : DWORD* in/out
' RequestIdStr : LPWSTR
Declare PtrSafe Function DhcpRequestParams Lib "dhcpcsvc" ( _
    ByVal Flags As Long, _
    ByVal Reserved As LongPtr, _
    ByVal AdapterName As LongPtr, _
    ByVal ClassId As LongPtr, _
    ByVal SendParams As LongPtr, _
    ByVal RecdParams As LongPtr, _
    ByVal Buffer As LongPtr, _
    ByRef pSize As Long, _
    ByVal RequestIdStr As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DhcpRequestParams = ctypes.windll.dhcpcsvc.DhcpRequestParams
DhcpRequestParams.restype = wintypes.DWORD
DhcpRequestParams.argtypes = [
    wintypes.DWORD,  # Flags : DWORD
    ctypes.POINTER(None),  # Reserved : void* in/out
    wintypes.LPCWSTR,  # AdapterName : LPWSTR
    ctypes.c_void_p,  # ClassId : DHCPCAPI_CLASSID* in/out
    DHCPCAPI_PARAMS_ARRAY,  # SendParams : DHCPCAPI_PARAMS_ARRAY
    DHCPCAPI_PARAMS_ARRAY,  # RecdParams : DHCPCAPI_PARAMS_ARRAY
    ctypes.POINTER(ctypes.c_ubyte),  # Buffer : BYTE* out
    ctypes.POINTER(wintypes.DWORD),  # pSize : DWORD* in/out
    wintypes.LPCWSTR,  # RequestIdStr : LPWSTR
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('dhcpcsvc.dll')
DhcpRequestParams = Fiddle::Function.new(
  lib['DhcpRequestParams'],
  [
    -Fiddle::TYPE_INT,  # Flags : DWORD
    Fiddle::TYPE_VOIDP,  # Reserved : void* in/out
    Fiddle::TYPE_VOIDP,  # AdapterName : LPWSTR
    Fiddle::TYPE_VOIDP,  # ClassId : DHCPCAPI_CLASSID* in/out
    Fiddle::TYPE_VOIDP,  # SendParams : DHCPCAPI_PARAMS_ARRAY
    Fiddle::TYPE_VOIDP,  # RecdParams : DHCPCAPI_PARAMS_ARRAY
    Fiddle::TYPE_VOIDP,  # Buffer : BYTE* out
    Fiddle::TYPE_VOIDP,  # pSize : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # RequestIdStr : LPWSTR
  ],
  -Fiddle::TYPE_INT)

#[link(name = "dhcpcsvc")]
extern "system" {
    fn DhcpRequestParams(
        Flags: u32,  // DWORD
        Reserved: *mut (),  // void* in/out
        AdapterName: *mut u16,  // LPWSTR
        ClassId: *mut DHCPCAPI_CLASSID,  // DHCPCAPI_CLASSID* in/out
        SendParams: DHCPCAPI_PARAMS_ARRAY,  // DHCPCAPI_PARAMS_ARRAY
        RecdParams: DHCPCAPI_PARAMS_ARRAY,  // DHCPCAPI_PARAMS_ARRAY
        Buffer: *mut u8,  // BYTE* out
        pSize: *mut u32,  // DWORD* in/out
        RequestIdStr: *mut u16  // LPWSTR
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("dhcpcsvc.dll")]
public static extern uint DhcpRequestParams(uint Flags, IntPtr Reserved, [MarshalAs(UnmanagedType.LPWStr)] string AdapterName, IntPtr ClassId, DHCPCAPI_PARAMS_ARRAY SendParams, DHCPCAPI_PARAMS_ARRAY RecdParams, IntPtr Buffer, ref uint pSize, [MarshalAs(UnmanagedType.LPWStr)] string RequestIdStr);
"@
$api = Add-Type -MemberDefinition $sig -Name 'dhcpcsvc_DhcpRequestParams' -Namespace Win32 -PassThru
# $api::DhcpRequestParams(Flags, Reserved, AdapterName, ClassId, SendParams, RecdParams, Buffer, pSize, RequestIdStr)

#uselib "dhcpcsvc.dll"
#func global DhcpRequestParams "DhcpRequestParams" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; DhcpRequestParams Flags, Reserved, AdapterName, varptr(ClassId), SendParams, RecdParams, varptr(Buffer), varptr(pSize), RequestIdStr   ; 戻り値は stat
; Flags : DWORD -> "sptr"
; Reserved : void* in/out -> "sptr"
; AdapterName : LPWSTR -> "sptr"
; ClassId : DHCPCAPI_CLASSID* in/out -> "sptr"
; SendParams : DHCPCAPI_PARAMS_ARRAY -> "sptr"
; RecdParams : DHCPCAPI_PARAMS_ARRAY -> "sptr"
; Buffer : BYTE* out -> "sptr"
; pSize : DWORD* in/out -> "sptr"
; RequestIdStr : LPWSTR -> "sptr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "dhcpcsvc.dll"
#cfunc global DhcpRequestParams "DhcpRequestParams" int, sptr, wstr, var, int, int, var, var, wstr
; res = DhcpRequestParams(Flags, Reserved, AdapterName, ClassId, SendParams, RecdParams, Buffer, pSize, RequestIdStr)
; Flags : DWORD -> "int"
; Reserved : void* in/out -> "sptr"
; AdapterName : LPWSTR -> "wstr"
; ClassId : DHCPCAPI_CLASSID* in/out -> "var"
; SendParams : DHCPCAPI_PARAMS_ARRAY -> "int"
; RecdParams : DHCPCAPI_PARAMS_ARRAY -> "int"
; Buffer : BYTE* out -> "var"
; pSize : DWORD* in/out -> "var"
; RequestIdStr : LPWSTR -> "wstr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "dhcpcsvc.dll"
#cfunc global DhcpRequestParams "DhcpRequestParams" int, sptr, wstr, sptr, int, int, sptr, sptr, wstr
; res = DhcpRequestParams(Flags, Reserved, AdapterName, varptr(ClassId), SendParams, RecdParams, varptr(Buffer), varptr(pSize), RequestIdStr)
; Flags : DWORD -> "int"
; Reserved : void* in/out -> "sptr"
; AdapterName : LPWSTR -> "wstr"
; ClassId : DHCPCAPI_CLASSID* in/out -> "sptr"
; SendParams : DHCPCAPI_PARAMS_ARRAY -> "int"
; RecdParams : DHCPCAPI_PARAMS_ARRAY -> "int"
; Buffer : BYTE* out -> "sptr"
; pSize : DWORD* in/out -> "sptr"
; RequestIdStr : LPWSTR -> "wstr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; DWORD DhcpRequestParams(DWORD Flags, void* Reserved, LPWSTR AdapterName, DHCPCAPI_CLASSID* ClassId, DHCPCAPI_PARAMS_ARRAY SendParams, DHCPCAPI_PARAMS_ARRAY RecdParams, BYTE* Buffer, DWORD* pSize, LPWSTR RequestIdStr)
#uselib "dhcpcsvc.dll"
#cfunc global DhcpRequestParams "DhcpRequestParams" int, intptr, wstr, var, int, int, var, var, wstr
; res = DhcpRequestParams(Flags, Reserved, AdapterName, ClassId, SendParams, RecdParams, Buffer, pSize, RequestIdStr)
; Flags : DWORD -> "int"
; Reserved : void* in/out -> "intptr"
; AdapterName : LPWSTR -> "wstr"
; ClassId : DHCPCAPI_CLASSID* in/out -> "var"
; SendParams : DHCPCAPI_PARAMS_ARRAY -> "int"
; RecdParams : DHCPCAPI_PARAMS_ARRAY -> "int"
; Buffer : BYTE* out -> "var"
; pSize : DWORD* in/out -> "var"
; RequestIdStr : LPWSTR -> "wstr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD DhcpRequestParams(DWORD Flags, void* Reserved, LPWSTR AdapterName, DHCPCAPI_CLASSID* ClassId, DHCPCAPI_PARAMS_ARRAY SendParams, DHCPCAPI_PARAMS_ARRAY RecdParams, BYTE* Buffer, DWORD* pSize, LPWSTR RequestIdStr)
#uselib "dhcpcsvc.dll"
#cfunc global DhcpRequestParams "DhcpRequestParams" int, intptr, wstr, intptr, int, int, intptr, intptr, wstr
; res = DhcpRequestParams(Flags, Reserved, AdapterName, varptr(ClassId), SendParams, RecdParams, varptr(Buffer), varptr(pSize), RequestIdStr)
; Flags : DWORD -> "int"
; Reserved : void* in/out -> "intptr"
; AdapterName : LPWSTR -> "wstr"
; ClassId : DHCPCAPI_CLASSID* in/out -> "intptr"
; SendParams : DHCPCAPI_PARAMS_ARRAY -> "int"
; RecdParams : DHCPCAPI_PARAMS_ARRAY -> "int"
; Buffer : BYTE* out -> "intptr"
; pSize : DWORD* in/out -> "intptr"
; RequestIdStr : LPWSTR -> "wstr"
; ※値渡し構造体は直接渡せません。intにパック、または var で構造体変数を渡してください。
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	dhcpcsvc = windows.NewLazySystemDLL("dhcpcsvc.dll")
	procDhcpRequestParams = dhcpcsvc.NewProc("DhcpRequestParams")
)

// Flags (DWORD), Reserved (void* in/out), AdapterName (LPWSTR), ClassId (DHCPCAPI_CLASSID* in/out), SendParams (DHCPCAPI_PARAMS_ARRAY), RecdParams (DHCPCAPI_PARAMS_ARRAY), Buffer (BYTE* out), pSize (DWORD* in/out), RequestIdStr (LPWSTR)
r1, _, err := procDhcpRequestParams.Call(
	uintptr(Flags),
	uintptr(Reserved),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(AdapterName))),
	uintptr(ClassId),
	uintptr(SendParams),
	uintptr(RecdParams),
	uintptr(Buffer),
	uintptr(pSize),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(RequestIdStr))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function DhcpRequestParams(
  Flags: DWORD;   // DWORD
  Reserved: Pointer;   // void* in/out
  AdapterName: PWideChar;   // LPWSTR
  ClassId: Pointer;   // DHCPCAPI_CLASSID* in/out
  SendParams: DHCPCAPI_PARAMS_ARRAY;   // DHCPCAPI_PARAMS_ARRAY
  RecdParams: DHCPCAPI_PARAMS_ARRAY;   // DHCPCAPI_PARAMS_ARRAY
  Buffer: Pointer;   // BYTE* out
  pSize: Pointer;   // DWORD* in/out
  RequestIdStr: PWideChar   // LPWSTR
): DWORD; stdcall;
  external 'dhcpcsvc.dll' name 'DhcpRequestParams';

result := DllCall("dhcpcsvc\DhcpRequestParams"
    , "UInt", Flags   ; DWORD
    , "Ptr", Reserved   ; void* in/out
    , "WStr", AdapterName   ; LPWSTR
    , "Ptr", ClassId   ; DHCPCAPI_CLASSID* in/out
    , "Ptr", SendParams   ; DHCPCAPI_PARAMS_ARRAY
    , "Ptr", RecdParams   ; DHCPCAPI_PARAMS_ARRAY
    , "Ptr", Buffer   ; BYTE* out
    , "Ptr", pSize   ; DWORD* in/out
    , "WStr", RequestIdStr   ; LPWSTR
    , "UInt")   ; return: DWORD

●DhcpRequestParams(Flags, Reserved, AdapterName, ClassId, SendParams, RecdParams, Buffer, pSize, RequestIdStr) = DLL("dhcpcsvc.dll", "dword DhcpRequestParams(dword, void*, char*, void*, void*, void*, void*, void*, char*)")
# 呼び出し: DhcpRequestParams(Flags, Reserved, AdapterName, ClassId, SendParams, RecdParams, Buffer, pSize, RequestIdStr)
# Flags : DWORD -> "dword"
# Reserved : void* in/out -> "void*"
# AdapterName : LPWSTR -> "char*"
# ClassId : DHCPCAPI_CLASSID* in/out -> "void*"
# SendParams : DHCPCAPI_PARAMS_ARRAY -> "void*"
# RecdParams : DHCPCAPI_PARAMS_ARRAY -> "void*"
# Buffer : BYTE* out -> "void*"
# pSize : DWORD* in/out -> "void*"
# RequestIdStr : LPWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "dhcpcsvc" fn DhcpRequestParams(
    Flags: u32, // DWORD
    Reserved: ?*anyopaque, // void* in/out
    AdapterName: [*c]const u16, // LPWSTR
    ClassId: [*c]DHCPCAPI_CLASSID, // DHCPCAPI_CLASSID* in/out
    SendParams: DHCPCAPI_PARAMS_ARRAY, // DHCPCAPI_PARAMS_ARRAY
    RecdParams: DHCPCAPI_PARAMS_ARRAY, // DHCPCAPI_PARAMS_ARRAY
    Buffer: [*c]u8, // BYTE* out
    pSize: [*c]u32, // DWORD* in/out
    RequestIdStr: [*c]const u16 // LPWSTR
) callconv(std.os.windows.WINAPI) u32;

proc DhcpRequestParams(
    Flags: uint32,  # DWORD
    Reserved: pointer,  # void* in/out
    AdapterName: WideCString,  # LPWSTR
    ClassId: ptr DHCPCAPI_CLASSID,  # DHCPCAPI_CLASSID* in/out
    SendParams: DHCPCAPI_PARAMS_ARRAY,  # DHCPCAPI_PARAMS_ARRAY
    RecdParams: DHCPCAPI_PARAMS_ARRAY,  # DHCPCAPI_PARAMS_ARRAY
    Buffer: ptr uint8,  # BYTE* out
    pSize: ptr uint32,  # DWORD* in/out
    RequestIdStr: WideCString  # LPWSTR
): uint32 {.importc: "DhcpRequestParams", stdcall, dynlib: "dhcpcsvc.dll".}

pragma(lib, "dhcpcsvc");
extern(Windows)
uint DhcpRequestParams(
    uint Flags,   // DWORD
    void* Reserved,   // void* in/out
    const(wchar)* AdapterName,   // LPWSTR
    DHCPCAPI_CLASSID* ClassId,   // DHCPCAPI_CLASSID* in/out
    DHCPCAPI_PARAMS_ARRAY SendParams,   // DHCPCAPI_PARAMS_ARRAY
    DHCPCAPI_PARAMS_ARRAY RecdParams,   // DHCPCAPI_PARAMS_ARRAY
    ubyte* Buffer,   // BYTE* out
    uint* pSize,   // DWORD* in/out
    const(wchar)* RequestIdStr   // LPWSTR
);

ccall((:DhcpRequestParams, "dhcpcsvc.dll"), stdcall, UInt32,
      (UInt32, Ptr{Cvoid}, Cwstring, Ptr{DHCPCAPI_CLASSID}, DHCPCAPI_PARAMS_ARRAY, DHCPCAPI_PARAMS_ARRAY, Ptr{UInt8}, Ptr{UInt32}, Cwstring),
      Flags, Reserved, AdapterName, ClassId, SendParams, RecdParams, Buffer, pSize, RequestIdStr)
# Flags : DWORD -> UInt32
# Reserved : void* in/out -> Ptr{Cvoid}
# AdapterName : LPWSTR -> Cwstring
# ClassId : DHCPCAPI_CLASSID* in/out -> Ptr{DHCPCAPI_CLASSID}
# SendParams : DHCPCAPI_PARAMS_ARRAY -> DHCPCAPI_PARAMS_ARRAY
# RecdParams : DHCPCAPI_PARAMS_ARRAY -> DHCPCAPI_PARAMS_ARRAY
# Buffer : BYTE* out -> Ptr{UInt8}
# pSize : DWORD* in/out -> Ptr{UInt32}
# RequestIdStr : LPWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
uint32_t DhcpRequestParams(
    uint32_t Flags,
    void* Reserved,
    const uint16_t* AdapterName,
    void* ClassId,
    DHCPCAPI_PARAMS_ARRAY SendParams,
    DHCPCAPI_PARAMS_ARRAY RecdParams,
    uint8_t* Buffer,
    uint32_t* pSize,
    const uint16_t* RequestIdStr);
]]
local dhcpcsvc = ffi.load("dhcpcsvc")
-- dhcpcsvc.DhcpRequestParams(Flags, Reserved, AdapterName, ClassId, SendParams, RecdParams, Buffer, pSize, RequestIdStr)
-- Flags : DWORD
-- Reserved : void* in/out
-- AdapterName : LPWSTR
-- ClassId : DHCPCAPI_CLASSID* in/out
-- SendParams : DHCPCAPI_PARAMS_ARRAY
-- RecdParams : DHCPCAPI_PARAMS_ARRAY
-- Buffer : BYTE* out
-- pSize : DWORD* in/out
-- RequestIdStr : LPWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('dhcpcsvc.dll');
const DhcpRequestParams = lib.func('__stdcall', 'DhcpRequestParams', 'uint32_t', ['uint32_t', 'void *', 'str16', 'void *', 'DHCPCAPI_PARAMS_ARRAY', 'DHCPCAPI_PARAMS_ARRAY', 'uint8_t *', 'uint32_t *', 'str16']);
// DhcpRequestParams(Flags, Reserved, AdapterName, ClassId, SendParams, RecdParams, Buffer, pSize, RequestIdStr)
// Flags : DWORD -> 'uint32_t'
// Reserved : void* in/out -> 'void *'
// AdapterName : LPWSTR -> 'str16'
// ClassId : DHCPCAPI_CLASSID* in/out -> 'void *'
// SendParams : DHCPCAPI_PARAMS_ARRAY -> 'DHCPCAPI_PARAMS_ARRAY'
// RecdParams : DHCPCAPI_PARAMS_ARRAY -> 'DHCPCAPI_PARAMS_ARRAY'
// Buffer : BYTE* out -> 'uint8_t *'
// pSize : DWORD* in/out -> 'uint32_t *'
// RequestIdStr : LPWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("dhcpcsvc.dll", {
  DhcpRequestParams: { parameters: ["u32", "pointer", "buffer", "pointer", "buffer", "buffer", "pointer", "pointer", "buffer"], result: "u32" },
});
// lib.symbols.DhcpRequestParams(Flags, Reserved, AdapterName, ClassId, SendParams, RecdParams, Buffer, pSize, RequestIdStr)
// Flags : DWORD -> "u32"
// Reserved : void* in/out -> "pointer"
// AdapterName : LPWSTR -> "buffer"
// ClassId : DHCPCAPI_CLASSID* in/out -> "pointer"
// SendParams : DHCPCAPI_PARAMS_ARRAY -> "buffer"
// RecdParams : DHCPCAPI_PARAMS_ARRAY -> "buffer"
// Buffer : BYTE* out -> "pointer"
// pSize : DWORD* in/out -> "pointer"
// RequestIdStr : LPWSTR -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
uint32_t DhcpRequestParams(
    uint32_t Flags,
    void* Reserved,
    const uint16_t* AdapterName,
    void* ClassId,
    DHCPCAPI_PARAMS_ARRAY SendParams,
    DHCPCAPI_PARAMS_ARRAY RecdParams,
    uint8_t* Buffer,
    uint32_t* pSize,
    const uint16_t* RequestIdStr);
C, "dhcpcsvc.dll");
// $ffi->DhcpRequestParams(Flags, Reserved, AdapterName, ClassId, SendParams, RecdParams, Buffer, pSize, RequestIdStr);
// Flags : DWORD
// Reserved : void* in/out
// AdapterName : LPWSTR
// ClassId : DHCPCAPI_CLASSID* in/out
// SendParams : DHCPCAPI_PARAMS_ARRAY
// RecdParams : DHCPCAPI_PARAMS_ARRAY
// Buffer : BYTE* out
// pSize : DWORD* in/out
// RequestIdStr : LPWSTR
// 構造体/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 Dhcpcsvc extends StdCallLibrary {
    Dhcpcsvc INSTANCE = Native.load("dhcpcsvc", Dhcpcsvc.class);
    int DhcpRequestParams(
        int Flags,   // DWORD
        Pointer Reserved,   // void* in/out
        WString AdapterName,   // LPWSTR
        Pointer ClassId,   // DHCPCAPI_CLASSID* in/out
        DHCPCAPI_PARAMS_ARRAY /* extends Structure (by value) */ SendParams,   // DHCPCAPI_PARAMS_ARRAY
        DHCPCAPI_PARAMS_ARRAY /* extends Structure (by value) */ RecdParams,   // DHCPCAPI_PARAMS_ARRAY
        byte[] Buffer,   // BYTE* out
        IntByReference pSize,   // DWORD* in/out
        WString RequestIdStr   // LPWSTR
    );
}

@[Link("dhcpcsvc")]
lib Libdhcpcsvc
  fun DhcpRequestParams = DhcpRequestParams(
    Flags : UInt32,   # DWORD
    Reserved : Void*,   # void* in/out
    AdapterName : UInt16*,   # LPWSTR
    ClassId : DHCPCAPI_CLASSID*,   # DHCPCAPI_CLASSID* in/out
    SendParams : DHCPCAPI_PARAMS_ARRAY,   # DHCPCAPI_PARAMS_ARRAY
    RecdParams : DHCPCAPI_PARAMS_ARRAY,   # DHCPCAPI_PARAMS_ARRAY
    Buffer : UInt8*,   # BYTE* out
    pSize : UInt32*,   # DWORD* in/out
    RequestIdStr : UInt16*   # LPWSTR
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DhcpRequestParamsNative = Uint32 Function(Uint32, Pointer<Void>, Pointer<Utf16>, Pointer<Void>, DHCPCAPI_PARAMS_ARRAY, DHCPCAPI_PARAMS_ARRAY, Pointer<Uint8>, Pointer<Uint32>, Pointer<Utf16>);
typedef DhcpRequestParamsDart = int Function(int, Pointer<Void>, Pointer<Utf16>, Pointer<Void>, int, int, Pointer<Uint8>, Pointer<Uint32>, Pointer<Utf16>);
final DhcpRequestParams = DynamicLibrary.open('dhcpcsvc.dll')
    .lookupFunction<DhcpRequestParamsNative, DhcpRequestParamsDart>('DhcpRequestParams');
// Flags : DWORD -> Uint32
// Reserved : void* in/out -> Pointer<Void>
// AdapterName : LPWSTR -> Pointer<Utf16>
// ClassId : DHCPCAPI_CLASSID* in/out -> Pointer<Void>
// SendParams : DHCPCAPI_PARAMS_ARRAY -> DHCPCAPI_PARAMS_ARRAY
// RecdParams : DHCPCAPI_PARAMS_ARRAY -> DHCPCAPI_PARAMS_ARRAY
// Buffer : BYTE* out -> Pointer<Uint8>
// pSize : DWORD* in/out -> Pointer<Uint32>
// RequestIdStr : LPWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function DhcpRequestParams(
  Flags: DWORD;   // DWORD
  Reserved: Pointer;   // void* in/out
  AdapterName: PWideChar;   // LPWSTR
  ClassId: Pointer;   // DHCPCAPI_CLASSID* in/out
  SendParams: DHCPCAPI_PARAMS_ARRAY;   // DHCPCAPI_PARAMS_ARRAY
  RecdParams: DHCPCAPI_PARAMS_ARRAY;   // DHCPCAPI_PARAMS_ARRAY
  Buffer: Pointer;   // BYTE* out
  pSize: Pointer;   // DWORD* in/out
  RequestIdStr: PWideChar   // LPWSTR
): DWORD; stdcall;
  external 'dhcpcsvc.dll' name 'DhcpRequestParams';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DhcpRequestParams"
  c_DhcpRequestParams :: Word32 -> Ptr () -> CWString -> Ptr () -> DHCPCAPI_PARAMS_ARRAY -> DHCPCAPI_PARAMS_ARRAY -> Ptr Word8 -> Ptr Word32 -> CWString -> IO Word32
-- Flags : DWORD -> Word32
-- Reserved : void* in/out -> Ptr ()
-- AdapterName : LPWSTR -> CWString
-- ClassId : DHCPCAPI_CLASSID* in/out -> Ptr ()
-- SendParams : DHCPCAPI_PARAMS_ARRAY -> DHCPCAPI_PARAMS_ARRAY
-- RecdParams : DHCPCAPI_PARAMS_ARRAY -> DHCPCAPI_PARAMS_ARRAY
-- Buffer : BYTE* out -> Ptr Word8
-- pSize : DWORD* in/out -> Ptr Word32
-- RequestIdStr : LPWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
-- ※値渡し構造体は GHC FFI で直接渡せません。Ptr で渡すラッパ(C側)経由にしてください。

open Ctypes
open Foreign

let dhcprequestparams =
  foreign "DhcpRequestParams"
    (uint32_t @-> (ptr void) @-> (ptr uint16_t) @-> (ptr void) @-> DHCPCAPI_PARAMS_ARRAY @-> DHCPCAPI_PARAMS_ARRAY @-> (ptr uint8_t) @-> (ptr uint32_t) @-> (ptr uint16_t) @-> returning uint32_t)
(* Flags : DWORD -> uint32_t *)
(* Reserved : void* in/out -> (ptr void) *)
(* AdapterName : LPWSTR -> (ptr uint16_t) *)
(* ClassId : DHCPCAPI_CLASSID* in/out -> (ptr void) *)
(* SendParams : DHCPCAPI_PARAMS_ARRAY -> DHCPCAPI_PARAMS_ARRAY *)
(* RecdParams : DHCPCAPI_PARAMS_ARRAY -> DHCPCAPI_PARAMS_ARRAY *)
(* Buffer : BYTE* out -> (ptr uint8_t) *)
(* pSize : DWORD* in/out -> (ptr uint32_t) *)
(* RequestIdStr : LPWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library dhcpcsvc (t "dhcpcsvc.dll"))
(cffi:use-foreign-library dhcpcsvc)

(cffi:defcfun ("DhcpRequestParams" dhcp-request-params :convention :stdcall) :uint32
  (flags :uint32)   ; DWORD
  (reserved :pointer)   ; void* in/out
  (adapter-name (:string :encoding :utf-16le))   ; LPWSTR
  (class-id :pointer)   ; DHCPCAPI_CLASSID* in/out
  (send-params (:struct dhcpcapi-params-array))   ; DHCPCAPI_PARAMS_ARRAY
  (recd-params (:struct dhcpcapi-params-array))   ; DHCPCAPI_PARAMS_ARRAY
  (buffer :pointer)   ; BYTE* out
  (p-size :pointer)   ; DWORD* in/out
  (request-id-str (:string :encoding :utf-16le)))   ; LPWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $DhcpRequestParams = Win32::API::More->new('dhcpcsvc',
    'DWORD DhcpRequestParams(DWORD Flags, LPVOID Reserved, LPCWSTR AdapterName, LPVOID ClassId, LPVOID SendParams, LPVOID RecdParams, LPVOID Buffer, LPVOID pSize, LPCWSTR RequestIdStr)');
# my $ret = $DhcpRequestParams->Call($Flags, $Reserved, $AdapterName, $ClassId, $SendParams, $RecdParams, $Buffer, $pSize, $RequestIdStr);
# Flags : DWORD -> DWORD
# Reserved : void* in/out -> LPVOID
# AdapterName : LPWSTR -> LPCWSTR
# ClassId : DHCPCAPI_CLASSID* in/out -> LPVOID
# SendParams : DHCPCAPI_PARAMS_ARRAY -> LPVOID
# RecdParams : DHCPCAPI_PARAMS_ARRAY -> LPVOID
# Buffer : BYTE* out -> LPVOID
# pSize : DWORD* in/out -> LPVOID
# RequestIdStr : LPWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

DhcpRequestParams

シグネチャ

パラメーター

公式ドキュメント

戻り値

解説(Remarks)

各言語での呼び出し定義

関連項目