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

DhcpCreateOptionV5

関数
クラス/ベンダー指定でDHCPオプション定義を作成する。
DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

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

DWORD DhcpCreateOptionV5(
    LPWSTR ServerIpAddress,   // optional
    DWORD Flags,
    DWORD OptionId,
    LPWSTR ClassName,   // optional
    LPWSTR VendorName,   // optional
    DHCP_OPTION* OptionInfo
);

パラメーター

名前方向説明
ServerIpAddressLPWSTRinoptional操作対象DHCPサーバのIPアドレスまたはホスト名(Unicode)。
FlagsDWORDinベンダ固有オプションか等を示すフラグ(DHCP_FLAGS_OPTION_IS_VENDOR等)。
OptionIdDWORDin作成するDHCPオプションのIDを指定する。
ClassNameLPWSTRinoptionalオプションが属するユーザクラス名(Unicode)へのポインタ。NULL可。
VendorNameLPWSTRinoptionalオプションが属するベンダクラス名(Unicode)へのポインタ。NULL可。
OptionInfoDHCP_OPTION*inout作成するオプションの定義を格納したDHCP_OPTION構造体へのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

DhcpCreateOptionV5 = ctypes.windll.dhcpsapi.DhcpCreateOptionV5
DhcpCreateOptionV5.restype = wintypes.DWORD
DhcpCreateOptionV5.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPWSTR optional
    wintypes.DWORD,  # Flags : DWORD
    wintypes.DWORD,  # OptionId : DWORD
    wintypes.LPCWSTR,  # ClassName : LPWSTR optional
    wintypes.LPCWSTR,  # VendorName : LPWSTR optional
    ctypes.c_void_p,  # OptionInfo : DHCP_OPTION* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpCreateOptionV5 = dhcpsapi.NewProc("DhcpCreateOptionV5")
)

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

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

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

let dhcpcreateoptionv5 =
  foreign "DhcpCreateOptionV5"
    ((ptr uint16_t) @-> uint32_t @-> uint32_t @-> (ptr uint16_t) @-> (ptr uint16_t) @-> (ptr void) @-> returning uint32_t)
(* ServerIpAddress : LPWSTR optional -> (ptr uint16_t) *)
(* Flags : DWORD -> uint32_t *)
(* OptionId : DWORD -> uint32_t *)
(* ClassName : LPWSTR optional -> (ptr uint16_t) *)
(* VendorName : LPWSTR optional -> (ptr uint16_t) *)
(* OptionInfo : DHCP_OPTION* 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 ("DhcpCreateOptionV5" dhcp-create-option-v5 :convention :stdcall) :uint32
  (server-ip-address (:string :encoding :utf-16le))   ; LPWSTR optional
  (flags :uint32)   ; DWORD
  (option-id :uint32)   ; DWORD
  (class-name (:string :encoding :utf-16le))   ; LPWSTR optional
  (vendor-name (:string :encoding :utf-16le))   ; LPWSTR optional
  (option-info :pointer))   ; DHCP_OPTION* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DhcpCreateOptionV5 = Win32::API::More->new('DHCPSAPI',
    'DWORD DhcpCreateOptionV5(LPCWSTR ServerIpAddress, DWORD Flags, DWORD OptionId, LPCWSTR ClassName, LPCWSTR VendorName, LPVOID OptionInfo)');
# my $ret = $DhcpCreateOptionV5->Call($ServerIpAddress, $Flags, $OptionId, $ClassName, $VendorName, $OptionInfo);
# ServerIpAddress : LPWSTR optional -> LPCWSTR
# Flags : DWORD -> DWORD
# OptionId : DWORD -> DWORD
# ClassName : LPWSTR optional -> LPCWSTR
# VendorName : LPWSTR optional -> LPCWSTR
# OptionInfo : DHCP_OPTION* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

類似 API
使用する型