Partilhar via


Função CreateSortedAddressPairs

A partir de uma lista fornecida de endereços IP potenciais, a função CreateSortedAddressPairs emparelha os endereços de destino com os endereços IP locais da máquina 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 [em, opcional]
    Reservado. Este parâmetro deve ser NULL.

  • SourceAddressCount [em]
    Reservado. Este parâmetro deve ser zero.

  • DestinationAddressList [em]
    Um ponteiro para uma lista de endereços de destino potenciais do tipo SOCKADDR_IN6.

  • DestinationAddressCount [em]
    O número de endereços na lista para os quais o parâmetro DestinationAddressList aponta.

  • AddressSortOptions [em]
    Reservado. Este parâmetro deve ser zero.

  • SortedAddressPairList [em]
    Um ponteiro para uma lista de pares de endereços de origem e 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 [saída]
    O número de pares de endereços na lista para os quais o parâmetro SortedAddressPairList aponta.

Valor de retorno

CreateSortedAddressPairs retorna 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 da máquina 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.

Requerimentos

Plataforma de destino

Universal

Versão

Disponível no Windows Vista e versões posteriores dos sistemas operacionais Windows.

Cabeçalho

Netioapi.h (inclui Netioapi.h)

Biblioteca

Netio.lib

IRQL

< DISPATCH_LEVEL

Ver também

FormatMessage

SOCKADDR_IN6