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

DhcpRemoveOptionValue

関数
指定スコープのDHCPオプション値を削除する。
DLLDHCPSAPI.dll呼出規約winapi対応OSwindowsserver2008

シグネチャ

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

DWORD DhcpRemoveOptionValue(
    LPCWSTR ServerIpAddress,   // optional
    DWORD OptionID,
    const DHCP_OPTION_SCOPE_INFO* ScopeInfo
);

パラメーター

名前方向説明
ServerIpAddressLPCWSTRinoptional操作対象DHCPサーバのIPアドレスまたはホスト名(Unicode)。
OptionIDDWORDin値を削除するDHCPオプションのIDを指定する。
ScopeInfoDHCP_OPTION_SCOPE_INFO*in削除対象の範囲を示すDHCP_OPTION_SCOPE_INFO構造体へのポインタ。

戻り値の型: DWORD

各言語での呼び出し定義

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

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

DhcpRemoveOptionValue = ctypes.windll.dhcpsapi.DhcpRemoveOptionValue
DhcpRemoveOptionValue.restype = wintypes.DWORD
DhcpRemoveOptionValue.argtypes = [
    wintypes.LPCWSTR,  # ServerIpAddress : LPCWSTR optional
    wintypes.DWORD,  # OptionID : DWORD
    ctypes.c_void_p,  # ScopeInfo : DHCP_OPTION_SCOPE_INFO*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	dhcpsapi = windows.NewLazySystemDLL("DHCPSAPI.dll")
	procDhcpRemoveOptionValue = dhcpsapi.NewProc("DhcpRemoveOptionValue")
)

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

extern "dhcpsapi" fn DhcpRemoveOptionValue(
    ServerIpAddress: [*c]const u16, // LPCWSTR optional
    OptionID: u32, // DWORD
    ScopeInfo: [*c]DHCP_OPTION_SCOPE_INFO // DHCP_OPTION_SCOPE_INFO*
) callconv(std.os.windows.WINAPI) u32;
proc DhcpRemoveOptionValue(
    ServerIpAddress: WideCString,  # LPCWSTR optional
    OptionID: uint32,  # DWORD
    ScopeInfo: ptr DHCP_OPTION_SCOPE_INFO  # DHCP_OPTION_SCOPE_INFO*
): uint32 {.importc: "DhcpRemoveOptionValue", stdcall, dynlib: "DHCPSAPI.dll".}
pragma(lib, "dhcpsapi");
extern(Windows)
uint DhcpRemoveOptionValue(
    const(wchar)* ServerIpAddress,   // LPCWSTR optional
    uint OptionID,   // DWORD
    DHCP_OPTION_SCOPE_INFO* ScopeInfo   // DHCP_OPTION_SCOPE_INFO*
);
ccall((:DhcpRemoveOptionValue, "DHCPSAPI.dll"), stdcall, UInt32,
      (Cwstring, UInt32, Ptr{DHCP_OPTION_SCOPE_INFO}),
      ServerIpAddress, OptionID, ScopeInfo)
# ServerIpAddress : LPCWSTR optional -> Cwstring
# OptionID : DWORD -> UInt32
# ScopeInfo : DHCP_OPTION_SCOPE_INFO* -> Ptr{DHCP_OPTION_SCOPE_INFO}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t DhcpRemoveOptionValue(
    const uint16_t* ServerIpAddress,
    uint32_t OptionID,
    void* ScopeInfo);
]]
local dhcpsapi = ffi.load("dhcpsapi")
-- dhcpsapi.DhcpRemoveOptionValue(ServerIpAddress, OptionID, ScopeInfo)
-- ServerIpAddress : LPCWSTR optional
-- OptionID : DWORD
-- ScopeInfo : DHCP_OPTION_SCOPE_INFO*
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('DHCPSAPI.dll');
const DhcpRemoveOptionValue = lib.func('__stdcall', 'DhcpRemoveOptionValue', 'uint32_t', ['str16', 'uint32_t', 'void *']);
// DhcpRemoveOptionValue(ServerIpAddress, OptionID, ScopeInfo)
// ServerIpAddress : LPCWSTR optional -> 'str16'
// OptionID : DWORD -> 'uint32_t'
// ScopeInfo : DHCP_OPTION_SCOPE_INFO* -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("DHCPSAPI.dll", {
  DhcpRemoveOptionValue: { parameters: ["buffer", "u32", "pointer"], result: "u32" },
});
// lib.symbols.DhcpRemoveOptionValue(ServerIpAddress, OptionID, ScopeInfo)
// ServerIpAddress : LPCWSTR optional -> "buffer"
// OptionID : DWORD -> "u32"
// ScopeInfo : DHCP_OPTION_SCOPE_INFO* -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t DhcpRemoveOptionValue(
    const uint16_t* ServerIpAddress,
    uint32_t OptionID,
    void* ScopeInfo);
C, "DHCPSAPI.dll");
// $ffi->DhcpRemoveOptionValue(ServerIpAddress, OptionID, ScopeInfo);
// ServerIpAddress : LPCWSTR optional
// OptionID : DWORD
// ScopeInfo : DHCP_OPTION_SCOPE_INFO*
// 構造体/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 DhcpRemoveOptionValue(
        WString ServerIpAddress,   // LPCWSTR optional
        int OptionID,   // DWORD
        Pointer ScopeInfo   // DHCP_OPTION_SCOPE_INFO*
    );
}
@[Link("dhcpsapi")]
lib LibDHCPSAPI
  fun DhcpRemoveOptionValue = DhcpRemoveOptionValue(
    ServerIpAddress : UInt16*,   # LPCWSTR optional
    OptionID : UInt32,   # DWORD
    ScopeInfo : DHCP_OPTION_SCOPE_INFO*   # DHCP_OPTION_SCOPE_INFO*
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef DhcpRemoveOptionValueNative = Uint32 Function(Pointer<Utf16>, Uint32, Pointer<Void>);
typedef DhcpRemoveOptionValueDart = int Function(Pointer<Utf16>, int, Pointer<Void>);
final DhcpRemoveOptionValue = DynamicLibrary.open('DHCPSAPI.dll')
    .lookupFunction<DhcpRemoveOptionValueNative, DhcpRemoveOptionValueDart>('DhcpRemoveOptionValue');
// ServerIpAddress : LPCWSTR optional -> Pointer<Utf16>
// OptionID : DWORD -> Uint32
// ScopeInfo : DHCP_OPTION_SCOPE_INFO* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function DhcpRemoveOptionValue(
  ServerIpAddress: PWideChar;   // LPCWSTR optional
  OptionID: DWORD;   // DWORD
  ScopeInfo: Pointer   // DHCP_OPTION_SCOPE_INFO*
): DWORD; stdcall;
  external 'DHCPSAPI.dll' name 'DhcpRemoveOptionValue';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "DhcpRemoveOptionValue"
  c_DhcpRemoveOptionValue :: CWString -> Word32 -> Ptr () -> IO Word32
-- ServerIpAddress : LPCWSTR optional -> CWString
-- OptionID : DWORD -> Word32
-- ScopeInfo : DHCP_OPTION_SCOPE_INFO* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let dhcpremoveoptionvalue =
  foreign "DhcpRemoveOptionValue"
    ((ptr uint16_t) @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* ServerIpAddress : LPCWSTR optional -> (ptr uint16_t) *)
(* OptionID : DWORD -> uint32_t *)
(* ScopeInfo : DHCP_OPTION_SCOPE_INFO* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library dhcpsapi (t "DHCPSAPI.dll"))
(cffi:use-foreign-library dhcpsapi)

(cffi:defcfun ("DhcpRemoveOptionValue" dhcp-remove-option-value :convention :stdcall) :uint32
  (server-ip-address (:string :encoding :utf-16le))   ; LPCWSTR optional
  (option-id :uint32)   ; DWORD
  (scope-info :pointer))   ; DHCP_OPTION_SCOPE_INFO*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $DhcpRemoveOptionValue = Win32::API::More->new('DHCPSAPI',
    'DWORD DhcpRemoveOptionValue(LPCWSTR ServerIpAddress, DWORD OptionID, LPVOID ScopeInfo)');
# my $ret = $DhcpRemoveOptionValue->Call($ServerIpAddress, $OptionID, $ScopeInfo);
# ServerIpAddress : LPCWSTR optional -> LPCWSTR
# OptionID : DWORD -> DWORD
# ScopeInfo : DHCP_OPTION_SCOPE_INFO* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

使用する型