ITAddress2::get_Phones method (tapi3if.h)

Article
02/22/2024

The get_Phones method returns a VARIANT pointer to an ITCollection of phone objects corresponding to the phone devices that can be used with this address.

This method is intended for Visual Basic and scripting applications. C/C++ applications should use the EnumeratePhones method instead.

Syntax

HRESULT get_Phones(
  [out] VARIANT *pPhones
);

Parameters

[out] pPhones

Pointer to a VARIANT containing an ITCollection of ITPhone interface pointers.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

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 via phoneGetID with device class tapi/line. If no phones are available for use with the address, this method produces an empty collection and returns S_OK.

TAPI calls the AddRef method on the ITPhone interface returned by ITAddress2::get_Phones. The application must call Release on the ITPhone 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