GetAnycastIpAddressEntry 関数 (netioapi.h)

[アーティクル]
08/25/2023

GetAnycastIpAddressEntry 関数は、ローカルコンピューター上の既存のエニーキャスト IP アドレスエントリの情報を取得します。

構文

IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API GetAnycastIpAddressEntry(
  [in, out] PMIB_ANYCASTIPADDRESS_ROW Row
);

パラメーター

[in, out] Row

エニーキャスト IP アドレスエントリの MIB_ANYCASTIPADDRESS_ROW 構造体エントリへのポインター。正常に戻ると、この構造体は既存のエニーキャスト IP アドレスのプロパティで更新されます。

戻り値

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

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

リターンコード	説明
ERROR_FILE_NOT_FOUND	指定されたファイルが見つかりません。 Row パラメーターが指すMIB_ANYCASTIPADDRESS_ROWの InterfaceLuid メンバーまたは InterfaceIndex メンバーによって指定されたネットワークインターフェイス LUID またはインターフェイスインデックスがローカルコンピューター上の値でない場合、このエラーが返されます。
ERROR_INVALID_PARAMETER	パラメーターが正しくありません。このエラーは、Row パラメーターに NULL ポインターが渡された場合、Row パラメーターが指すMIB_ANYCASTIPADDRESS_ROWの Address メンバーが有効なエニーキャスト IPv4 アドレスまたは IPv6 アドレスに設定されていない場合、または Row パラメーターが指すMIB_ANYCASTIPADDRESS_ROWの InterfaceLuid メンバーまたは InterfaceIndex メンバーの両方が指定されていない場合に返されます。
ERROR_NOT_FOUND	Element not found. Row パラメーターが指すMIB_ANYCASTIPADDRESS_ROW構造体の InterfaceLuid または InterfaceIndex メンバーによって指定されたネットワークインターフェイスが、MIB_ANYCASTIPADDRESS_ROW構造体の Address メンバーで指定された IP アドレスとアドレスファミリと一致しない場合、このエラーが返されます。
ERROR_NOT_SUPPORTED	要求はサポートされていません。このエラーは、ローカルコンピューター上に IPv4 スタックがなく、Row パラメーターが指すMIB_UNICASTIPADDRESS_ROW構造体の Address メンバーに IPv4 アドレスが指定されている場合に返されます。このエラーは、ローカルコンピューター上に IPv6 スタックがなく、アドレスメンバーに IPv6 アドレスが指定されている場合に返されます。
その他	FormatMessage を使用して、返されたエラーのメッセージ文字列を取得します。

注釈

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

GetAnycastIpAddressEntry 関数は、既存のMIB_ANYCASTIPADDRESS_ROW構造体エントリを取得するために使用されます。

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

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

呼び出しが成功すると、GetAnycastIpAddressEntry はエニーキャスト IP アドレスの他のプロパティを取得し、Row パラメーターが指すMIB_ANYCASTIPADDRESS_ROW構造体に入力します。

GetAnycastIpAddressTable 関数を呼び出して、ローカルコンピューター上のエニーキャスト IP アドレスエントリを列挙できます。

要件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	netioapi.h (Iphlpapi.h を含む)
Library	Iphlpapi.lib
[DLL]	Iphlpapi.dll