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

DhcpGetClientOptions

関数
指定クライアントに適用されるDHCPオプションを取得する。
DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

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

DWORD DhcpGetClientOptions(
    LPCWSTR ServerIpAddress,   // optional
    DWORD ClientIpAddress,
    DWORD ClientSubnetMask,
    DHCP_OPTION_LIST** ClientOptions
);

パラメーター

名前方向説明
ServerIpAddressLPCWSTRinoptional操作対象DHCPサーバのIPアドレスまたはホスト名(Unicode)。
ClientIpAddressDWORDin対象クライアントのIPアドレスをDWORDで指定する。
ClientSubnetMaskDWORDin対象クライアントのサブネットマスクをDWORDで指定する。
ClientOptionsDHCP_OPTION_LIST**inout取得したクライアント向けオプション一覧を受け取るDHCP_OPTION_LISTへのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

DhcpGetClientOptions = ctypes.windll.dhcpsapi.DhcpGetClientOptions
DhcpGetClientOptions.restype = wintypes.DWORD
DhcpGetClientOptions.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPCWSTR optional
    wintypes.DWORD,  # ClientIpAddress : DWORD
    wintypes.DWORD,  # ClientSubnetMask : DWORD
    ctypes.c_void_p,  # ClientOptions : DHCP_OPTION_LIST** in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpGetClientOptions = dhcpsapi.NewProc("DhcpGetClientOptions")
)

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

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

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

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

関連項目

使用する型