ITAddress2::EnumeratePhones method (tapi3if.h)

Article
10/13/2021

The EnumeratePhones method enumerates the phone objects corresponding to the phone devices that can be used with this address.

This method is intended for C/C++ applications. Visual Basic and scripting applications must use the get_Phones method.

Syntax

HRESULT EnumeratePhones(
  [out] IEnumPhone **ppEnumPhone
);

Parameters

[out] ppEnumPhone

Pointer to the new IEnumPhone interface.

Return value

This method can return one of these values.

Value	Meaning
S_OK	Method succeeded.
E_POINTER	The ppEnumPhone parameter is not a valid pointer.
E_OUTOFMEMORY	Insufficient memory exists to perform the operation.
E_UNEXPECTED	The method failed for unknown reasons.

Remarks

A phone device declares itself as being available on all addresses that support audio terminals by the TSP setting the PHONEFEATURE_GENERICPHONE bit in the dwPhoneFeatures member of the PHONECAPS structure. A phone device can also declare itself as being preferred to an address or set of addresses by returning address/line IDs using phoneGetID with device class tapi/line. If no phones are available for use with the address, this method produces an empty enumeration and returns S_OK.

TAPI calls the AddRef method on the IEnumPhone interface returned by ITAddress2::EnumeratePhones. The application must call Release on the IEnumPhone interface to free resources associated with it.

Requirements

Requirement	Value
Target Platform	Windows
Header	tapi3if.h (include Tapi3.h)
Library	Uuid.lib
DLL	Tapi3.dll