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

IpReleaseAddress

関数
指定アダプターのDHCPで取得したIPアドレスを解放する。
DLLIPHLPAPI.dll呼出規約winapi対応OSWindows 2000 以降

シグネチャ

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

DWORD IpReleaseAddress(
    IP_ADAPTER_INDEX_MAP* AdapterInfo
);

パラメーター

名前方向説明
AdapterInfoIP_ADAPTER_INDEX_MAP*in解放する IPv4 アドレスに関連付けられたアダプターを指定する IP_ADAPTER_INDEX_MAP 構造体へのポインターです。

戻り値の型: DWORD

公式ドキュメント

IpReleaseAddress 関数は、以前に Dynamic Host Configuration Protocol (DHCP) を通じて取得した IPv4 アドレスを解放します。

戻り値

関数が成功した場合、戻り値は NO_ERROR です。

関数が失敗した場合は、 FormatMessage を使用して、返されたエラーのメッセージ文字列を取得してください。

戻り値 説明
ERROR_INVALID_PARAMETER
パラメーターのいずれかが無効です。このエラーは、AdapterInfo パラメーターが NULL の場合、または AdapterInfo パラメーターが指す PIP_ADAPTER_INDEX_MAP 構造体の Name メンバーが無効な場合に返されます。
ERROR_PROC_NOT_FOUND
IPv4 アドレスの解放を要求する DHCP への処理中に例外が発生しました。
その他
FormatMessage を使用して、返されたエラーのメッセージ文字列を取得してください。

解説(Remarks)

IpReleaseAddress 関数は IPv4 専用であり、以前に Dynamic Host Configuration Protocol (DHCP) を通じて取得した IPv4 アドレスのみを解放します。解放する DHCP アドレスを特定するために使用されるのは、AdapterInfo パラメーターが指す IP_ADAPTER_INDEX_MAP 構造体の Name メンバーのみです。

IP_ADAPTER_INDEX_MAP 構造体の配列は、GetInterfaceInfo 関数によって IP_INTERFACE_INFO 構造体内に返されます。GetInterfaceInfo によって返される IP_INTERFACE_INFO 構造体は、IP_INTERFACE_INFO 構造体の NumAdapters メンバーが IPv4 が有効なネットワークアダプターが存在しないことを示している場合でも、少なくとも 1 つの IP_ADAPTER_INDEX_MAP 構造体を含みます。GetInterfaceInfo によって返される IP_INTERFACE_INFO 構造体の NumAdapters メンバーが 0 の場合、IP_INTERFACE_INFO 構造体内に返される単一の IP_ADAPTER_INDEX_MAP 構造体のメンバーの値は未定義です。

AdapterInfo パラメーターが指す IP_ADAPTER_INDEX_MAP 構造体の Name メンバーが NULL の場合、IpReleaseAddress 関数は ERROR_INVALID_PARAMETER を返します。

IPv6 アドレスを解放または更新するための関数は用意されていません。これは Ipconfig コマンドを実行することによってのみ実行できます。

ipconfig /release6

ipconfig /renew6

次の例では、ローカルシステム上で IPv4 が有効なネットワークアダプターの一覧を取得し、その一覧の最初のアダプターについて IPv4 アドレスの解放と更新を行います。

#ifndef WIN32_LEAN_AND_MEAN
#define WIN32_LEAN_AND_MEAN
#endif

#include <winsock2.h>
#include <iphlpapi.h>
#include <stdio.h>

#pragma comment(lib, "iphlpapi.lib")

#define MALLOC(x) HeapAlloc(GetProcessHeap(), 0, (x)) 
#define FREE(x) HeapFree(GetProcessHeap(), 0, (x))

// Before calling IpReleaseAddress and IpRenewAddress we use
// GetInterfaceInfo to retrieve a handle to the adapter

void __cdecl main()
{
    ULONG ulOutBufLen = 0;
    DWORD dwRetVal = 0;
    PIP_INTERFACE_INFO pInfo;

    pInfo = (IP_INTERFACE_INFO *) MALLOC(sizeof(IP_INTERFACE_INFO));

    // Make an initial call to GetInterfaceInfo to get
    // the necessary size into the ulOutBufLen variable
    if (GetInterfaceInfo(pInfo, &ulOutBufLen) == ERROR_INSUFFICIENT_BUFFER) {
        FREE(pInfo);
        pInfo = (IP_INTERFACE_INFO *) MALLOC (ulOutBufLen);
    }

    // Make a second call to GetInterfaceInfo to get the
    // actual data we want
    if ((dwRetVal = GetInterfaceInfo(pInfo, &ulOutBufLen)) == NO_ERROR ) {
        printf("\tAdapter Name: %ws\n", pInfo->Adapter[0].Name);
        printf("\tAdapter Index: %ld\n", pInfo->Adapter[0].Index);
        printf("\tNum Adapters: %ld\n", pInfo->NumAdapters);
    }
    else if (dwRetVal == ERROR_NO_DATA) {
        printf("There are no network adapters with IPv4 enabled on the local system\n");
        return;
    }
    else {
        LPVOID lpMsgBuf;
        printf("GetInterfaceInfo failed.\n");
            
        if (FormatMessage( 
            FORMAT_MESSAGE_ALLOCATE_BUFFER | 
            FORMAT_MESSAGE_FROM_SYSTEM | 
            FORMAT_MESSAGE_IGNORE_INSERTS,
            NULL,
            dwRetVal,
            MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // Default language
            (LPTSTR) &lpMsgBuf,
            0,
            NULL )) {
            printf("\tError: %s", lpMsgBuf);
        }
        LocalFree( lpMsgBuf );
        return;
    }

// Call IpReleaseAddress and IpRenewAddress to release and renew
// the IP address on the first network adapter returned 
// by the call to GetInterfaceInfo.
    if ((dwRetVal = IpReleaseAddress(&pInfo->Adapter[0])) == NO_ERROR) {
        printf("IP release succeeded.\n");
    }
    else {
        printf("IP release failed: %ld\n", dwRetVal);
    }

    if ((dwRetVal = IpRenewAddress(&pInfo->Adapter[0])) == NO_ERROR) {
        printf("IP renew succeeded.\n");
    }
    else {
        printf("IP renew failed: %ld\n", dwRetVal);
    }

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

各言語での呼び出し定義

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

DWORD IpReleaseAddress(
    IP_ADAPTER_INDEX_MAP* AdapterInfo
);
[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint IpReleaseAddress(
    IntPtr AdapterInfo   // IP_ADAPTER_INDEX_MAP*
);
<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function IpReleaseAddress(
    AdapterInfo As IntPtr   ' IP_ADAPTER_INDEX_MAP*
) As UInteger
End Function
' AdapterInfo : IP_ADAPTER_INDEX_MAP*
Declare PtrSafe Function IpReleaseAddress Lib "iphlpapi" ( _
    ByVal AdapterInfo As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

IpReleaseAddress = ctypes.windll.iphlpapi.IpReleaseAddress
IpReleaseAddress.restype = wintypes.DWORD
IpReleaseAddress.argtypes = [
    ctypes.c_void_p,  # AdapterInfo : IP_ADAPTER_INDEX_MAP*
]
require 'fiddle'
require 'fiddle/import'

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

var (
	iphlpapi = windows.NewLazySystemDLL("IPHLPAPI.dll")
	procIpReleaseAddress = iphlpapi.NewProc("IpReleaseAddress")
)

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

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

typedef IpReleaseAddressNative = Uint32 Function(Pointer<Void>);
typedef IpReleaseAddressDart = int Function(Pointer<Void>);
final IpReleaseAddress = DynamicLibrary.open('IPHLPAPI.dll')
    .lookupFunction<IpReleaseAddressNative, IpReleaseAddressDart>('IpReleaseAddress');
// AdapterInfo : IP_ADAPTER_INDEX_MAP* -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function IpReleaseAddress(
  AdapterInfo: Pointer   // IP_ADAPTER_INDEX_MAP*
): DWORD; stdcall;
  external 'IPHLPAPI.dll' name 'IpReleaseAddress';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "IpReleaseAddress"
  c_IpReleaseAddress :: Ptr () -> IO Word32
-- AdapterInfo : IP_ADAPTER_INDEX_MAP* -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let ipreleaseaddress =
  foreign "IpReleaseAddress"
    ((ptr void) @-> returning uint32_t)
(* AdapterInfo : IP_ADAPTER_INDEX_MAP* -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library iphlpapi (t "IPHLPAPI.dll"))
(cffi:use-foreign-library iphlpapi)

(cffi:defcfun ("IpReleaseAddress" ip-release-address :convention :stdcall) :uint32
  (adapter-info :pointer))   ; IP_ADAPTER_INDEX_MAP*
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $IpReleaseAddress = Win32::API::More->new('IPHLPAPI',
    'DWORD IpReleaseAddress(LPVOID AdapterInfo)');
# my $ret = $IpReleaseAddress->Call($AdapterInfo);
# AdapterInfo : IP_ADAPTER_INDEX_MAP* -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型