CreateUnicastIpAddressEntry

ローカルコンピュータに新しいユニキャスト IP アドレスエントリを追加する。

CreateUnicastIpAddressEntry Row

Row : [var] ユニキャスト IP アドレスエントリを表す MIB_UNICASTIPADDRESS_ROW 構造体へのポインタ。

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

解説

ローカルコンピュータに新しいユニキャスト IP アドレスエントリを追加する。

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

[備考]
CreateUnicastIpAddressEntry 関数は Windows Vista
以降で定義される。ローカルコンピュータに新しいユニキャスト IP
アドレスエントリを追加する。追加されたアドレスは永続的ではなく、アダプタが存在する間だけ有効である。再起動や NIC リセット、PnP
イベントで破棄される。永続 IPv4 アドレスには WMI の Win32_NetworkAdapterConfiguration の
EnableStatic や netsh を使う。InitializeUnicastIpAddressEntry
でメンバを既定値に初期化してから必要なメンバを変更し本関数を呼ぶとよい。Address メンバは有効なユニキャスト IPv4 / IPv6
アドレス (si_family を AF_INET / AF_INET6 にセット) で初期化し、InterfaceLuid または
InterfaceIndex のいずれかも初期化する必要がある。OnLinkPrefixLength が 255
の場合はアドレス長に等しいプレフィックス長 (IPv4 なら 32、IPv6 なら 128) が設定される。間違った場合は
SetUnicastIpAddressEntry で修正できる。DadState、ScopeId、CreationTimeStamp
は無視される。Windows 10 以降では DadState に IpDadStatePreferred を設定すると楽観的 DAD
が実行される。既存アドレスと重複する場合は失敗する。ループバック IP アドレスはループバックインターフェイスにのみ追加可能。追加直後は
DAD (重複アドレス検出) が完了するまでアドレスは使用できず、IPv6 で約 1 秒、IPv4 で約 3
秒かかる。使用可能になったかは GetUnicastIpAddressEntry のポーリング、または NotifyAddrChange
/ NotifyIpInterfaceChange / NotifyUnicastIpAddressChange
による通知で確認できる。DadState が IpDadStatePreferred
になれば使用可能、IpDadStateTentative なら未完了、それ以外は DAD 失敗でアドレスは使用できない。本関数は
Administrators グループのメンバーとしてログオンしたユーザーからのみ呼び出せる。Administrators
グループのメンバーでないユーザーが呼び出すと ERROR_ACCESS_DENIED を返して失敗する。Windows Vista
以降のユーザーアカウント制御 (UAC) によっても失敗しうる。この関数を含むアプリケーションをビルトイン Administrator
以外の Administrators グループのメンバーが実行した場合、マニフェストファイルで
requestedExecutionLevel を requireAdministrator
に設定していない限りこの呼び出しは失敗する。マニフェストがない場合は、昇格シェル (管理者として実行) から起動する必要がある。

情報