Função CreateSortedAddressPairs
A partir de uma lista fornecida de endereços de destino IP potenciais, a função CreateSortedAddressPairs emparelha os endereços de destino junto com os endereços IP locais do computador host e classifica os pares de acordo com a ordem preferencial de comunicação.
Sintaxe
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
);
Parâmetros
SourceAddressList [in, opcional]
Reservado. Esse parâmetro deve ser NULL.SourceAddressCount [in]
Reservado. Esse parâmetro deve ser zero.DestinationAddressList [in]
Um ponteiro para uma lista de endereços de destino potenciais do tipo SOCKADDR_IN6.DestinationAddressCount [in]
O número de endereços na lista para o qual o parâmetro DestinationAddressList aponta.AddressSortOptions [in]
Reservado. Esse parâmetro deve ser zero.SortedAddressPairList [in]
Um ponteiro para uma lista de pares de endereços de origem e de destino, classificados na ordem preferencial de comunicação. Para obter mais informações sobre esse parâmetro, consulte a seção Comentários a seguir.SortedAddressPairCount [out]
O número de pares de endereços na lista para o qual o parâmetro SortedAddressPairList aponta.
Retornar valor
CreateSortedAddressPairs retornará STATUS_SUCCESS se a função for bem-sucedida.
Se a função falhar, CreateSortedAddressPairs retornará um dos seguintes códigos de erro:
| Código de retorno | Descrição |
|---|---|
| STATUS_INVALID_PARAMETER | Um parâmetro inválido foi passado para a função. |
| STATUS_NOT_ENOUGH_MEMORY | Recursos de memória insuficientes estavam disponíveis para concluir a operação. |
| Outros | Use a função FormatMessage para obter a cadeia de caracteres de mensagem para o erro retornado. |
Comentários
A função CreateSortedAddressPairs emparelha automaticamente os endereços locais do computador host com a lista fornecida de endereços de destino potenciais para os quais o parâmetro DestinationAddressList aponta.
A lista retornada de pares de endereços para os quais o parâmetro SortedAddressPairList aponta é classificada para que os pares de endereços mais adequados para comunicação entre dois pares ocorram anteriormente na lista.
O parâmetro SortedAddressPairList é do tipo PSOCKADDR_IN6_PAIR, que é definido no cabeçalho Ws2ipdef.h da seguinte maneira.
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.
Requisitos
Plataforma de destino |
Universal |
Versão |
Disponível no Windows Vista e versões posteriores dos sistemas operacionais Windows. |
Cabeçalho |
Netioapi.h (inclua Netioapi.h) |
Biblioteca |
Netio.lib |
IRQL |
< DISPATCH_LEVEL |