createSortedAddressPairs 函式 (netioapi.h)
CreateSortedAddressPairs 函式會取得可能IP目的地位址的提供清單、將目的地位址與主電腦的本機IP位址配對,並根據哪一個位址組最適合兩個對等之間的通訊來排序配對。
語法
IPHLPAPI_DLL_LINKAGE _NETIOAPI_SUCCESS_ NETIOAPI_API CreateSortedAddressPairs(
[in, optional] const PSOCKADDR_IN6 SourceAddressList,
[in] ULONG SourceAddressCount,
[in] const PSOCKADDR_IN6 DestinationAddressList,
[in] ULONG DestinationAddressCount,
[in] ULONG AddressSortOptions,
[out] PSOCKADDR_IN6_PAIR *SortedAddressPairList,
[out] ULONG *SortedAddressPairCount
);
參數
[in, optional] SourceAddressList
必須是 NULL。 保留供未來使用。
[in] SourceAddressCount
必須是 0。 保留供未來使用。
[in] DestinationAddressList
包含潛在 IPv6 目的地地址清單 之SOCKADDR_IN6 結構的數位指標。 任何 IPv4 位址都必須以 IPv4 對應 IPv6 位址格式來表示,這可讓 IPv6 僅應用程式與 IPv4 節點通訊。
[in] DestinationAddressCount
DestinationAddressList 參數所指向的目的地位址數目。
[in] AddressSortOptions
保留供未來使用。
[out] SortedAddressPairList
儲存 SOCKADDR_IN6_PAIR 結構的陣列指標,如果函式呼叫成功,則為包含一組 IPv6 位址的清單,以慣用的通訊順序排序。
[out] SortedAddressPairCount
如果函數調用成功,則為儲存 SortedAddressPairList 參數所指向之位址組數目的指標。
傳回值
如果函式成功,傳回值會NO_ERROR。
如果函式失敗,傳回值就是下列其中一個錯誤碼。
傳回碼 | Description |
---|---|
|
無效的參數已傳遞至 函式。 如果 DestinationAddressList、 SortedAddressPairList 或 SortedAddressPairCount 參數 NULL 或 DestinationAddressCount 大於 500,就會傳回此錯誤。 如果 SourceAddressList 不是 NULL 或 SourceAddressPairCount 參數不是零,也會傳回此錯誤。 |
|
沒有足夠的記憶體可用來處理此命令。 |
|
不支援此要求。 如果本機計算機上沒有IPv6堆疊,則會傳回此錯誤。 |
|
使用 FormatMessage 取得傳回錯誤的訊息字串。 |
備註
CreateSortedAddressPairs 函式是在 Windows Vista 和更新版本上定義。
CreateSortedAddressPairs 函式會採用來源和目的地 IPv6 位址的清單,並以排序順序傳回一組地址清單。 清單會依據哪一個位址組最適合來源和目的地地址之間的通訊進行排序。
SourceAddressList 所指向的來源位址清單目前保留供未來使用,而且必須是 NULL 指標。 SourceAddressCount 目前保留供未來使用,且必須為零。 CreateSortedAddressPairs 函式目前會針對來源地址清單使用所有主計算機的本機位址。
DestinationAddressList 參數會指向目的地地址清單。 目的地地址清單是 SOCKADDR_IN6 結構的陣列。 任何 IPv4 位址都必須以 IPv4 對應 IPv6 位址格式來表示,這可讓 IPv6 僅應用程式與 IPv4 節點通訊。 如需 IPv4 對應 IPv6 位址格式的詳細資訊,請參閱 雙堆疊套接字。 DestinationAddressCount 參數包含 DestinationAddressList 參數所指向的目的地地址數目。 CreateSortedAddressPairs 函式最多支援 500 個目的地位址。
如果 CreateSortedAddressPairs 函式成功, SortedAddressPairList 參數會指向包含已排序位址組 的SOCKADDR_IN6_PAIR 結構數位。 當不再需要這個傳回的清單時,請呼叫 FreeMibTable 函式來釋放清單所使用的記憶體。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2008 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | netioapi.h (包含 Iphlpapi.h) |
程式庫 | Iphlpapi.lib |
Dll | Iphlpapi.dll |