Platform SDK: TAPI

ITTAPI::EnumerateAddresses

Enumerates addresses currently available. Provided for C and C++ applications. Automation client applications, such as those written in Visual Basic, must use the get_Addresses method.

HRESULT EnumerateAddresses(
  IEnumAddress **ppEnumAddress
);

Parameters

ppEnumAddress
[out, retval] Pointer to IEnumAddress interface.

Return Values

Value Meaning
S_OK Method succeeded.
E_POINTER The ppEnumAddress parameter is not a valid pointer.
E_INVALIDARG The TAPI object has not been initialized.
E_OUTOFMEMORY Insufficient memory exists to perform the operation.

Remarks

An application typically uses this enumeration to check the capabilities of each address and determine which are useful for current purposes.

If an expected address is not found, this may indicate that the appropriate service provider has not been installed or is not working correctly.

The application must call the Release method on the returned enumeration to free resources associated with it.

If an address is created or removed during a TAPI session, the application will be notified through the ITTAPIEventNotification interface. If an address has been created, such as by installing a Plug and Play device, the ITTAPIEventNotification::Event returns the TE_ADDRESSCREATE member of the TAPIOBJECT_EVENT enum. If an address is removed, ITTAPIEventNotification::Event returns TE_ADDRESSREMOVE. Calling EnumerateAddresses after these events will reflect the current addresses.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Version: Requires TAPI 3.0 or later.
  Header: Declared in Tapi3.h.
  Library: Use T3iid.lib.

See Also

ITTAPI, get_Addresses, IEnumAddress, ITAddress, TAPI Object