ITAddressCapabilities::get_AddressCapabilityString method (tapi3if.h)

The get_AddressCapabilityString method gets the capability string for a given ADDRESS_CAPABILITY_STRING.

Syntax

HRESULT get_AddressCapabilityString(
  [in]  ADDRESS_CAPABILITY_STRING AddressCapString,
  [out] BSTR                      *ppCapabilityString
);

Parameters

[in] AddressCapString

Descriptor for desired address capability string.

[out] ppCapabilityString

Pointer to BSTR value of address capability. NULL is a possible return value if the TSP does not provide a value for AddressCapString.

Return value

This method can return one of these values.

Return code Description
S_OK
Method succeeded.
E_INVALIDARG
The AddressCapString parameter is not valid.
E_POINTER
The ppCapabilityString parameter is not a valid pointer.
TAPI_E_NOTSUPPORTED
TAPI version is not 3.0 or higher.
E_OUTOFMEMORY
Insufficient memory exists to perform the operation.

Remarks

The application must use SysFreeString to free the memory allocated for the ppCapabilityString parameter.

Requirements

Requirement Value
Target Platform Windows
Header tapi3if.h (include Tapi3.h)
Library Uuid.lib
DLL Tapi3.dll

See also

ADDRESS_CAPABILITY_STRING

Address Object

ITAddressCapabilities