Функция CreateSortedAddressPairs
Из предоставленного списка потенциальных IP-адресов CreateSortedAddressPairs функция объединяет адреса назначения вместе с локальными IP-адресами хост-компьютера и сортирует пары в соответствии с предпочтительным порядком связи.
Синтаксис
NETIOAPI_API CreateSortedAddressPairs(
_In_opt_ const PSOCKADDR_IN6 SourceAddressList,
_In_ ULONG SourceAddressCount,
_In_ const PSOCKADDR_IN6 DestinationAddressList,
_In_ ULONG DestinationAddressCount,
_In_ ULONG AddressSortOptions,
_In_ PSOCKADDR_IN6_PAIR *SortedAddressPairList,
_Out_ ULONG *SortedAddressPairCount
);
Параметры
SourceAddressList [in, необязательный]
Скрытный. Этот параметр должен быть null.SourceAddressCount [in]
Скрытный. Этот параметр должен быть равен нулю.DestinationAddressList [in]
Указатель на список потенциальных адресов назначения типа SOCKADDR_IN6.DestinationAddressCount [in]
Количество адресов в списке, на которые указывает параметр DestinationAddressList.AddressSortOptions [in]
Скрытный. Этот параметр должен быть равен нулю.SortedAddressPairList [in]
Указатель на список пар исходных и целевых адресов, отсортированный в предпочтительном порядке связи. Дополнительные сведения об этом параметре см. в следующем разделе "Примечания".SortedAddressPairCount [out]
Количество пар адресов в списке, на которые указывает параметр sortedAddressPairList.
Возвращаемое значение
CreateSortedAddressPairs возвращает STATUS_SUCCESS, если функция выполнена успешно.
Если функция завершается ошибкой, CreateSortedAddressPairs возвращает один из следующих кодов ошибок:
Возвращаемый код | Описание |
---|---|
STATUS_INVALID_PARAMETER | Недопустимый параметр был передан функции. |
STATUS_NOT_ENOUGH_MEMORY | Недостаточно ресурсов памяти было доступно для завершения операции. |
Другие | Используйте функцию FormatMessage, чтобы получить строку сообщения для возвращаемой ошибки. |
Замечания
Функция CreateSortedAddressPairs автоматически связывает локальные адреса хост-компьютера вместе с указанным списком потенциальных целевых адресов, на которые указывает параметр DestinationAddress List.
Возвращенный список пар адресов, которые SortedAddressPair List указывает на сортировку параметров, чтобы пары адресов, которые лучше всего подходили для обмена данными между двумя одноранговыми узлами, выполнялись ранее в списке.
Параметр SortedAddressPairList имеет тип PSOCKADDR_IN6_PAIR, который определен в заголовке Ws2ipdef.h следующим образом.
typedef struct _sockaddr_in6_pair
{
PSOCKADDR_IN6 SourceAddress;
PSOCKADDR_IN6 DestinationAddress;
} SOCKADDR_IN6_PAIR, *PSOCKADDR_IN6_PAIR;
- **SourceAddress**
The IP source address.
- **DestinationAddress**
The IP destination address.