Método ITPhone::EnumeratePreferredAddresses (tapi3if.h)

Artigo
03/02/2024

O método EnumeratePreferredAddresses enumera os endereços preferenciais para o objeto de telefone. O aplicativo não precisa chamar ITPhone::Open antes de executar esse método.

Esse método destina-se a aplicativos C/C++. O Visual Basic e os aplicativos de script devem usar o método get_Addresses .

Sintaxe

HRESULT EnumeratePreferredAddresses(
  [out] IEnumAddress **ppEnumAddress
);

Parâmetros

[out] ppEnumAddress

Ponteiro para um local em que, com êxito, o método coloca um ponteiro para um objeto de enumeração que contém a lista de endereços. Para obter mais informações, consulte a seção Comentários a seguir.

Retornar valor

Esse método pode retornar um desses valores.

Valor	Significado
S_OK	O método foi bem-sucedido.
E_POINTER	O parâmetro ppEnumAddress não é um ponteiro válido.
E_OUTOFMEMORY	Não há memória suficiente para alocar o objeto de enumeração.

Comentários

Se não houver endereços utilizáveis presentes no sistema, esse método produzirá uma enumeração vazia e retornará S_OK.

Um dispositivo de telefone se declara preferencial para um endereço ou conjunto de endereços retornando IDs de endereço/linha usando a função phoneGetID TAPI 2.x com a classe de dispositivo tapi/line.

Embora a função phoneGetID exija o identificador para um dispositivo de telefone aberto, o aplicativo não precisa chamar o método ITPhone::Open antes de chamar EnumeratePreferredAddresses. Isso ocorre porque a implementação do objeto de telefone pode abrir o telefone e chamar phoneGetID durante a inicialização do TAPI ou quando um novo objeto de telefone é exibido.

O TAPI chama o método AddRef na interface IEnumAddress retornada por ITPhone::EnumeratePreferredAddresses. O aplicativo deve chamar Release na interface IEnumAddress para liberar recursos associados a ele.