DeleteUnicastIpAddressEntry 関数
DeleteUnicastIpAddressEntry 関数は、ローカル コンピューター上の既存のユニキャスト IP アドレス エントリを削除します。
構文
NETIOAPI_API DeleteUnicastIpAddressEntry(
_In_ const MIB_UNICASTIPADDRESS_ROW *Row
);
パラメーター
- Row [in]
ローカル コンピューターから削除する 既存のユニキャスト IP アドレス エントリのMIB_UNICASTIPADDRESS_ROW 構造体エントリへのポインター。
戻り値
DeleteUnicastIpAddressEntry は、関数が成功した場合に STATUS_SUCCESS を返します。
関数が失敗した場合、DeleteUnicastIpAddressEntry は次のいずれかのエラー コードを返します:
| リターン コード | 説明 |
|---|---|
| STATUS_INVALID_PARAMETER | その関数に無効なパラメーターが渡された。 このエラーは、Row パラメーターに NULL ポインターが渡された場合、Row パラメーターが指す MIB_UNICASTIPADDRESS_ROW 構造体の Address メンバーに有効なユニキャスト IPv4 または IPv6 アドレスが設定されなかった場合、または、MIB_UNICASTIPADDRESS_ROW 構造体の InterfaceLuid メンバーと InterfaceIndex メンバーの両方が指定されていない場合に返されます。 |
| STATUS_NOT_FOUND | 指定されたインターフェイスが見つかりませんでした。 このエラーは、Row パラメーターが指す MIB_UNICASTIPADDRESS_ROW 構造体の InterfaceLuid メンバーまたは InterfaceIndex メンバーで指定されるネットワーク インターフェイスを関数が見つけられない場合に返されます。 |
| STATUS_NOT_SUPPORTED | 要求はサポートされていません。 このエラーは、ローカル コンピューターに IPv4 スタックが存在せず、Row パラメーターが指す MIB_UNICASTIPADDRESS_ROW 構造体の Address メンバーに IPv4 アドレスが指定されていた場合、またはローカル コンピューターに IPv6 スタックが存在せず、Address メンバーに IPv6 アドレスが指定されていた場合に返されます。 |
| その他 | FormatMessage 関数を使用して、返されたエラーのメッセージ文字列を取得します。 |
解説
DeleteUnicastIpAddressEntry 関数は、ローカル コンピューター上の既存のMIB_UNICASTIPADDRESS_ROW構造体エントリを削除するために使用されます。
入力時に、ドライバーは、 Row パラメーターが指す MIB_UNICASTIPADDRESS_ROW構造体の次のメンバーを初期化する必要があります。
住所
有効な IPv4 または IPv6 ユニキャスト アドレスとファミリに設定します。InterfaceLuid または InterfaceIndex
これらのメンバーは、前に示した順序で使用されます。 したがって、InterfaceLuid が指定されている場合は、このメンバーを使用してインターフェイスが決定されます。 InterfaceLuid メンバーに値が設定されていない (このメンバーの値がゼロに設定されている) 場合は、InterfaceIndex メンバーが次にインターフェイスを決定するために使用されます。
関関数が成功すると、Rowパラメーターが表す既存の IP アドレスが削除されます。
ドライバーは、GetUnicastIpAddressTable 関数を呼び出して、ローカル コンピューター上のユニキャスト IP アドレス エントリを列挙できます。 ドライバーは、GetUnicastIpAddressEntry 関数を呼び出して、特定の既存のユニキャスト IP アドレス エントリを取得できます。
要件
対象プラットフォーム |
ユニバーサル |
バージョン |
Windows Vista 以降のバージョンの Windows オペレーティング システムで使用できます。 |
ヘッダー |
Netioapi.h (Netioapi.h を含む) |
ライブラリ |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |