Fungsi CreateSortedAddressPairs (netioapi.h)

Artikel
02/29/2024

Fungsi CreateSortedAddressPairs mengambil daftar alamat tujuan IP potensial yang disediakan, memasangkan alamat tujuan dengan alamat IP lokal komputer host, dan mengurutkan pasangan sesuai dengan pasangan alamat mana yang paling cocok untuk komunikasi antara kedua rekan.

Sintaks

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
);

Parameter

[in, optional] SourceAddressList

Harus NULL. Disiapkan untuk penggunaan masa mendatang.

[in] SourceAddressCount

Harus 0. Disiapkan untuk penggunaan masa mendatang.

[in] DestinationAddressList

Penunjuk ke array struktur SOCKADDR_IN6 yang berisi daftar alamat tujuan IPv6 potensial. Setiap alamat IPv4 harus diwakili dalam format alamat IPv6 yang dipetakan IPv4 yang memungkinkan aplikasi hanya IPv6 untuk berkomunikasi dengan simpul IPv4.

[in] DestinationAddressCount

Jumlah alamat tujuan yang ditujukan oleh parameter DestinationAddressList .

[in] AddressSortOptions

Disiapkan untuk penggunaan masa mendatang.

[out] SortedAddressPairList

Penunjuk untuk menyimpan array struktur SOCKADDR_IN6_PAIR yang berisi daftar pasangan alamat IPv6 yang diurutkan dalam urutan komunikasi yang disukai, jika panggilan fungsi berhasil.

[out] SortedAddressPairCount

Penunjuk untuk menyimpan jumlah pasangan alamat yang ditujukan oleh parameter SortedAddressPairList , jika panggilan fungsi berhasil.

Nilai kembali

Jika fungsi berhasil, nilai yang dikembalikan adalah NO_ERROR.

Jika fungsi gagal, nilai yang dikembalikan adalah salah satu kode kesalahan berikut.

Menampilkan kode	Deskripsi
ERROR_INVALID_PARAMETER	Parameter yang tidak valid diteruskan ke fungsi. Kesalahan ini dikembalikan jika parameter DestinationAddressList, SortedAddressPairList, atau SortedAddressPairCountNULL, atau DestinationAddressCount lebih besar dari 500. Kesalahan ini juga dikembalikan jika SourceAddressList bukan NULL atau parameter SourceAddressPairCount bukan nol.
ERROR_NOT_ENOUGH_MEMORY	Penyimpanan tidak cukup tersedia untuk memproses perintah ini.
ERROR_NOT_SUPPORTED	Permintaan tidak didukung. Kesalahan ini dikembalikan jika tidak ada tumpukan IPv6 pada komputer lokal.
Lainnya	Gunakan FormatMessage untuk mendapatkan string pesan untuk kesalahan yang dikembalikan.

Keterangan

Fungsi CreateSortedAddressPairs didefinisikan pada Windows Vista dan yang lebih baru.

Fungsi CreateSortedAddressPairs mengambil daftar alamat IPv6 sumber dan tujuan, dan mengembalikan daftar pasangan alamat dalam urutan yang diurutkan. Daftar diurutkan menurut pasangan alamat mana yang paling cocok untuk komunikasi antara alamat sumber dan tujuan.

Daftar alamat sumber yang ditujukan oleh SourceAddressList saat ini dicadangkan untuk masa mendatang dan harus menjadi penunjuk NULL . SourceAddressCount saat ini dicadangkan untuk masa mendatang dan harus nol. Fungsi CreateSortedAddressPairs saat ini menggunakan semua alamat lokal komputer host untuk daftar alamat sumber.

Daftar alamat tujuan ditujukan ke oleh parameter DestinationAddressList . Daftar alamat tujuan adalah array struktur SOCKADDR_IN6 . Setiap alamat IPv4 harus diwakili dalam format alamat IPv6 yang dipetakan IPv4 yang memungkinkan aplikasi hanya IPv6 untuk berkomunikasi dengan simpul IPv4. Untuk informasi selengkapnya tentang format alamat IPv6 yang dipetakan IPv4, lihat Soket Tumpukan Ganda. Parameter DestinationAddressCount berisi jumlah alamat tujuan yang ditujukan oleh parameter DestinationAddressList . Fungsi CreateSortedAddressPairs mendukung maksimal 500 alamat tujuan.

Jika fungsi CreateSortedAddressPairs berhasil, parameter SortedAddressPairList menunjuk ke array struktur SOCKADDR_IN6_PAIR yang berisi pasangan alamat yang diurutkan. Ketika daftar yang dikembalikan ini tidak lagi diperlukan, kosongkan memori yang digunakan oleh daftar dengan memanggil fungsi FreeMibTable .

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2008 [hanya aplikasi desktop]
Target Platform	Windows
Header	netioapi.h (termasuk Iphlpapi.h)
Pustaka	Iphlpapi.lib
DLL	Iphlpapi.dll