Edit

ITAddress2::EnumeratePreferredPhones method (tapi3if.h)

  • Article

The EnumeratePreferredPhones method enumerates the preferred phone objects for this address.

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

Syntax

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

Parameters

[out] ppEnumPhone

Pointer to the location where, on success, this method will place a pointer to an enumeration object that contains the returned list of phones.

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
 There is not enough memory to allocate the enumeration object.

Remarks

A phone device declares 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::EnumeratePreferredPhones. 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

See also

IEnumPhone

ITAddress2