ITAddressTranslation::get_Locations method (tapi3if.h)

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

Syntax

HRESULT get_Locations(
  [out] VARIANT *pVariant
);

Parameters

[out] pVariant

Pointer to VARIANT containing an ITCollection of ITLocationInfo interface pointers (location objects).

Return value

This method can return one of these values.

Value Meaning
S_OK
Method succeeded.
E_POINTER
The pVariant parameter is not a valid pointer.
E_OUTOFMEMORY
Insufficient memory exists to perform the operation.

Remarks

The get_Locations 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 ITLocationInfo interface returned by ITAddressTranslation::get_Locations. The application must call Release on the ITLocationInfo 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

EnumerateLocations

ITAddressTranslation

ITCollection

ITLocationInfo