Share via

IUccEndpoint.Uri Property

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Gets the SIP URI associated with this endpoint.

Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)

Syntax

'Declaration
ReadOnly Property Uri As UccUri

UccUri Uri { get; }

property UccUri^ Uri {
    UccUri^ get ();
}

/** @property */
UccUri get_Uri ()

function get Uri () : UccUri

Property Value

A value of the IUccUri** (IUccUri, for a .NET application) type.

Remarks

The IUccUri interface instance returned by this property represents the local user. This interface provides a client with information relating to the local user's network communication characteristics. Various properties are exposed, including:

  • Address of record. This is the local user's SIP address string.

  • Transport mode. The property returns a value enumerated by UCC_TRANSPORT_MODE.

  • User. This is a User Id string such as "jaya" from a SIP address of "SIP:jaya@contoso.com"

Win32 COM/C++ Syntax

HRESULT get_Uri
(
   IUccUri** ppUri
);

Note

In a Win32 application, the return value of a method or property is always an HRESULT value indicating the status of the call to the interface member. Any result of the operation is returned as a parameter marked with the [out, retval] attribute. In contrast, in a .NET application the HRESULT value indicating an error condition is returned as a COM exception and the [out, retval] parameter becomes the return value. For the UCC API-defined HRESULT values, see Trace and Handle Errors in Unified Communications Client API.

Example

The example reads the Value property of the returned IUccUri object. The resulting value is the local users's SIP Uri address.

Console.WriteLine(
   "Endpoint Uri:" +
   this.endpoint.Uri.Value);

Thread Safety

All public static (Shared in Visual Basic) members of this type are thread-safe. Instance members are not guaranteed to be thread-safe.

Platforms

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2000 with Service Pack 4, Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition

Target Platforms

See Also

Reference

IUccEndpoint Interface
IUccEndpoint Members
Microsoft.Office.Interop.UccApi Namespace