AddIPAddress

AddIPAddress 関数は、指定した IPv4 アドレスを指定のアダプタに追加する。

AddIPAddress Address, IpMask, IfIndex, NTEContext, NTEInstance

Address : [int] アダプタに追加する IPv4 アドレス。IPAddr 構造体の形式で指定する。
IpMask : [int] Address パラメータで指定した IPv4 アドレスのサブネットマスク。IPMask パラメータは IPAddr 構造体と同じ形式を用いる。
IfIndex : [int] IPv4 アドレスを追加するアダプタのインデックス。
NTEContext : [var] ULONG 変数へのポインタ。成功時、このパラメータは追加された IPv4 アドレスに対する Net Table Entry (NTE) コンテキストを指す。呼び出し元は後で DeleteIPAddress 関数を呼ぶ際にこのコンテキストを利用できる。
NTEInstance : [var] ULONG 変数へのポインタ。成功時、このパラメータは追加された IPv4 アドレスに対する NTE インスタンスを指す。

(プラグイン / モジュール : iphlpapi.dll)

解説

AddIPAddress 関数は、指定した IPv4 アドレスを指定のアダプタに追加する。

[戻り値]
関数が成功すると戻り値は NO_ERROR となる。失敗した場合の戻り値は以下のいずれかのエラーコードとなる。
このドキュメントは省略されている。

[備考]
AddIPAddress 関数は、ローカルコンピュータ上に新しい IPv4 アドレスエントリを追加するのに使う。AddIPAddress
が追加する IPv4 アドレスは永続的ではなく、アダプタオブジェクトが存在する間だけ有効である。コンピュータを再起動するか NIC
を手動でリセットすると IPv4 アドレスは破棄される。特定の PnP イベントでも破棄されうる。永続的な IPv4
アドレスを作成するには WMI の Win32_NetworkAdapterConfiguration クラスの EnableStatic
メソッドや netsh コマンドを利用する。詳細は Windows Sockets ドキュメントの Netsh.exe
に関する記述を参照。Windows Server 2003 / XP / 2000 では、Address に指定した IPv4
アドレスがネットワーク上に既に存在する場合、AddIPAddress は NO_ERROR を返すが追加された IPv4 アドレスは
0.0.0.0 となる。Windows Vista
以降では、既存アドレスと重複する場合、IP_ADAPTER_UNICAST_ADDRESS 構造体の IP_DAD_STATE メンバが
IpDadStateDuplicate に設定された状態で重複アドレスが追加される。AddIPAddress で追加した IPv4
アドレスは、AddIPAddress が返した NTEContext を渡して DeleteIPAddress
を呼ぶことで後から削除できる。IPAddr / IPMask データ型については Windows Data Types
を参照。ドット区切り十進表記と IPAddr 形式を相互変換するには inet_addr / inet_ntoa を使う。Windows
Vista 以降では CreateUnicastIpAddressEntry 関数を使ってユニキャスト IPv4/IPv6
アドレスを追加できる。

情報