Edit

Share via

ITAddressTranslation::EnumerateLocations method (tapi3if.h)

  • Article

The EnumerateLocations method enumerates the currently available address locations. This method is provided for C and C++ applications. Automation client applications, such as those written in Visual Basic, must use the get_Locations method.

Syntax

HRESULT EnumerateLocations(
  [out] IEnumLocation **ppEnumLocation
);

Parameters

[out] ppEnumLocation

Pointer to IEnumLocation object created.

Return value

This method can return one of these values.

Value Meaning
S_OK
 Method succeeded.
E_POINTER
 The ppEnumLocations parameter is not a valid pointer.
E_OUTOFMEMORY
 Insufficient memory exists to create object.

Remarks

The EnumerateLocations method is a COM wrapper for the TAPI 2.1 LineGetTranslateCaps function, and takes location information from the LINETRANSLATECAPS structure returned by that function.

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

Address Object

IEnumLocation

ITAddressTranslation