ホーム › NetworkManagement.IpHelper › DeleteAnycastIpAddressEntry

DeleteAnycastIpAddressEntry

関数

指定したエニーキャストIPアドレスエントリを削除する。

DLLIPHLPAPI.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

WIN32_ERROR DeleteAnycastIpAddressEntry(
    const MIB_ANYCASTIPADDRESS_ROW* Row
);

パラメーター

名前	型	方向	説明
Row	MIB_ANYCASTIPADDRESS_ROW*	in	ローカルコンピューターから削除する既存のエニーキャスト IP アドレスエントリを表す MIB_ANYCASTIPADDRESS_ROW 構造体エントリへのポインター。

戻り値の型: WIN32_ERROR

公式ドキュメント

ローカルコンピューター上の既存のエニーキャスト IP アドレスエントリを削除します。

戻り値

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

関数が失敗した場合、戻り値は次のいずれかのエラーコードになります。

戻り値コード	説明
ERROR_ACCESS_DENIED	アクセスが拒否されました。このエラーは、次のような複数の条件下で返されます。ユーザーがローカルコンピューター上で必要な管理者権限を持っていない場合、またはアプリケーションが組み込みの Administrator として昇格されたシェル(RunAs administrator)で実行されていない場合などです。
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。このエラーは、Row パラメーターに NULL ポインターが渡された場合、Row パラメーターが指す MIB_ANYCASTIPADDRESS_ROW の Address メンバーが有効なユニキャスト IPv4 または IPv6 アドレスに設定されていない場合、または Row パラメーターが指す MIB_ANYCASTIPADDRESS_ROW の InterfaceLuid メンバーと InterfaceIndex メンバーの両方が未指定であった場合に返されます。
ERROR_NOT_FOUND	指定されたインターフェイスが見つかりませんでした。このエラーは、Row パラメーターが指す MIB_ANYCASTIPADDRESS_ROW の InterfaceLuid または InterfaceIndex メンバーで指定されたネットワークインターフェイスが見つからなかった場合に返されます。
ERROR_NOT_SUPPORTED	要求がサポートされていません。このエラーは、ローカルコンピューターに IPv4 スタックが存在しないのに、Row パラメーターが指す MIB_ANYCASTIPADDRESS_ROW の Address メンバーに IPv4 アドレスが指定された場合に返されます。また、ローカルコンピューターに IPv6 スタックが存在しないのに、Address メンバーに IPv6 アドレスが指定された場合にも返されます。
その他	返されたエラーのメッセージ文字列を取得するには、 FormatMessage を使用してください。

解説(Remarks)

DeleteAnycastIpAddressEntry 関数は、Windows Vista 以降で定義されています。

DeleteAnycastIpAddressEntry 関数は、ローカルコンピューター上の既存の MIB_ANYCASTIPADDRESS_ROW 構造体エントリを削除するために使用します。

入力時には、Row パラメーターが指す MIB_ANYCASTIPADDRESS_ROW 構造体の Address メンバーに、有効なユニキャスト IPv4 または IPv6 アドレスおよびファミリーを設定する必要があります。さらに、Row パラメーターが指す MIB_ANYCASTIPADDRESS_ROW 構造体の次のメンバーのうち、少なくとも 1 つを初期化する必要があります。InterfaceLuid または InterfaceIndex です。

これらのフィールドは、上記の順序で使用されます。したがって、InterfaceLuid が指定されている場合は、このメンバーを使用してインターフェイスが特定されます。InterfaceLuid メンバーに値が設定されていない場合(このメンバーの値がゼロに設定されている場合)は、次に InterfaceIndex メンバーを使用してインターフェイスが特定されます。

関数が成功すると、Row パラメーターで表される既存の IP アドレスが削除されます。

GetAnycastIpAddressTable 関数を呼び出すことで、ローカルコンピューター上のエニーキャスト IP アドレスエントリを列挙できます。GetAnycastIpAddressEntry 関数を呼び出すことで、特定の既存のエニーキャスト IP アドレスエントリを取得できます。

DeleteAnycastIpAddressEntry 関数は、Administrators グループのメンバーとしてログオンしているユーザーのみが呼び出すことができます。Administrators グループのメンバーでないユーザーが DeleteAnycastIpAddressEntry を呼び出した場合、この関数呼び出しは失敗し、ERROR_ACCESS_DENIED が返されます。この関数は、Windows Vista 以降のユーザーアカウント制御(UAC)が原因で失敗することもあります。この関数を含むアプリケーションが、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーによって実行された場合、マニフェストファイルで requestedExecutionLevel が requireAdministrator に設定されていない限り、この呼び出しは失敗します。アプリケーションにこのマニフェストファイルがない場合、組み込みの Administrator 以外の Administrators グループのメンバーとしてログオンしているユーザーは、この関数が成功するためには、組み込みの Administrator として昇格されたシェル(RunAs administrator)でアプリケーションを実行する必要があります。

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

各言語での呼び出し定義

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

WIN32_ERROR DeleteAnycastIpAddressEntry(
    const MIB_ANYCASTIPADDRESS_ROW* Row
);

[DllImport("IPHLPAPI.dll", ExactSpelling = true)]
static extern uint DeleteAnycastIpAddressEntry(
    IntPtr Row   // MIB_ANYCASTIPADDRESS_ROW*
);

<DllImport("IPHLPAPI.dll", ExactSpelling:=True)>
Public Shared Function DeleteAnycastIpAddressEntry(
    Row As IntPtr   ' MIB_ANYCASTIPADDRESS_ROW*
) As UInteger
End Function

' Row : MIB_ANYCASTIPADDRESS_ROW*
Declare PtrSafe Function DeleteAnycastIpAddressEntry Lib "iphlpapi" ( _
    ByVal Row As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

DeleteAnycastIpAddressEntry = ctypes.windll.iphlpapi.DeleteAnycastIpAddressEntry
DeleteAnycastIpAddressEntry.restype = wintypes.DWORD
DeleteAnycastIpAddressEntry.argtypes = [
    ctypes.c_void_p,  # Row : MIB_ANYCASTIPADDRESS_ROW*
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('IPHLPAPI.dll')
DeleteAnycastIpAddressEntry = Fiddle::Function.new(
  lib['DeleteAnycastIpAddressEntry'],
  [
    Fiddle::TYPE_VOIDP,  # Row : MIB_ANYCASTIPADDRESS_ROW*
  ],
  -Fiddle::TYPE_INT)

#[link(name = "iphlpapi")]
extern "system" {
    fn DeleteAnycastIpAddressEntry(
        Row: *const MIB_ANYCASTIPADDRESS_ROW  // MIB_ANYCASTIPADDRESS_ROW*
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("IPHLPAPI.dll")]
public static extern uint DeleteAnycastIpAddressEntry(IntPtr Row);
"@
$api = Add-Type -MemberDefinition $sig -Name 'IPHLPAPI_DeleteAnycastIpAddressEntry' -Namespace Win32 -PassThru
# $api::DeleteAnycastIpAddressEntry(Row)

#uselib "IPHLPAPI.dll"
#func global DeleteAnycastIpAddressEntry "DeleteAnycastIpAddressEntry" sptr
; DeleteAnycastIpAddressEntry varptr(Row)   ; 戻り値は stat
; Row : MIB_ANYCASTIPADDRESS_ROW* -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "IPHLPAPI.dll"
#cfunc global DeleteAnycastIpAddressEntry "DeleteAnycastIpAddressEntry" var
; res = DeleteAnycastIpAddressEntry(Row)
; Row : MIB_ANYCASTIPADDRESS_ROW* -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "IPHLPAPI.dll"
#cfunc global DeleteAnycastIpAddressEntry "DeleteAnycastIpAddressEntry" sptr
; res = DeleteAnycastIpAddressEntry(varptr(Row))
; Row : MIB_ANYCASTIPADDRESS_ROW* -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。