IUccSubscriber.Uri Property

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 and sets the URI of the subscriber.

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

Syntax

'Declaration
Property Uri As UccUri

UccUri Uri { get; set; }

property UccUri^ Uri {
    UccUri^ get ();
    void set (UccUri^ value);
}

/** @property */
UccUri get_Uri ()

/** @property */
void set_Uri (UccUri value)

function get Uri () : UccUri

function set Uri (value : UccUri)

Property Value

A value of the IUccUri** (IUccUri, for a .NET application) type. This is the SIP URI of the remote user subscribing to category instances of the local user.

Remarks

The Uri property of the IUccSubscriber interface provides a local client with an IUccUri interface that provides the Uri string necessary to create a corresponding subscription to the remote user's presentity.

A client can set the value of this property. This is intended to allow an application to automatically acknowledge a given subscriber. It is not currently supported.

Win32 COM/C++ Syntax

HRESULT get_Uri
(
   IUccUri** ppUri
);
HRESULT put_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 following example is a constructor for a class that provides a wrapper for the IUccSubscriber interface. The Uri property of the IUccSubscriber object is read and converted to a string for display.

public class subscriber
{
   Boolean _acknowledged;
   String _Uri;
   String _sourceNetwork;
   String _User;
...// class methods and properties...
   public subscriber(IUccSubscriber pSubscriber)
   {
      this._acknowledged = pSubscriber.Acknowledged;
      this._sourceNetwork = pSubscriber.SourceType.ToString();
      Console.WriteLine(
         "Subscribing user Uri: " + 
         pSubscriber.Uri.AddressOfRecord);
      this._Uri = pSubscriber.Uri.AddressOfRecord;
      this._User = pSubscriber.Uri.User;
   }
}

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

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