IUccPresenceContactCardInstance.Urls 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 all the URLs of this contact card.

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

Syntax

'Declaration
ReadOnly Property Urls As IUccCollection

IUccCollection Urls { get; }

property IUccCollection^ Urls {
    IUccCollection^ get ();
}

/** @property */
IUccCollection get_Urls ()

function get Urls () : IUccCollection

Property Value

A value of the IUccCollection** (IUccCollection, for a .NET application) type. Each element of this collection is a IUccPresenceContactCardUrl instance.

Remarks

The collection of IUccPresenceContactCardUrl can contain up to 4 items corresponding to the URL types enumerated by UCC_CONTACT_CARD_URL_TYPE. If an URL instance of a given type exists in the collection, calling AddUrl and passing an URL instance of that type will replace the existing URL rather than create a new URL.

This property can return an empty collection. It is not required that a user publish any URLs.

Win32 COM/C++ Syntax

HRESULT get_Urls
(
   IUccCollection** ppUrls
);

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 sample accepts a StringBuilder instance and an IUccPresenceContactCardInstance. The example uses the UCC_CONTACT_CARD_URL_TYPE enumeration to determine the type of Url represented by an individual Url in the contact card Urls collection (pCard.Urls) to update the StringBuilder instance with the correct Url type label. Each Url in the collection is extracted and added to the StringBuilder instance and finally, the updated StringBuilder is returned to calling code.

/// <summary>
/// Returns an updated StringBuilder instance. contact card Urls appended to 
/// existing string builder content
/// </summary>
/// <param name="sb">StringBuilder to update</param>
/// <param name="pCard">IuccPresenceContactCardInstance containing phones</param>
/// <returns>updated StringBuilder instance</returns>
private StringBuilder GetUrls(StringBuilder sb, IUccPresenceContactCardInstance pCard)
{
   if (pCard.Urls.Count > 0)
   {
      foreach (IUccPresenceContactCardUrl url in pCard.Urls)
      {
         sb.Append(System.Environment.NewLine);
         switch (url.Type)
         {
            case UCC_CONTACT_CARD_URL_TYPE.UCCCCUT_OTHER:
               sb.Append("Other Url: " + url.Url);
               break;
            case UCC_CONTACT_CARD_URL_TYPE.UCCCCUT_SHAREPOINT:
               sb.Append("Sharepoint Url: " + url.Url);
               break;
            case UCC_CONTACT_CARD_URL_TYPE.UCCCCUT_UNKNOWN:
               sb.Append("Unknown Url: " + url.Url);
               break;
            case UCC_CONTACT_CARD_URL_TYPE.UCCCCUT_VOICEMAIL:
               sb.Append("Voicemail Url: " + url.Url);
               break;
         }
      }
   }

   return sb;
}

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

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