IUccPresenceContactCardInstance.CreateUrl Method

  • 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.

Creates a URL to be added to the contact card.

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

Syntax

'Declaration
Function CreateUrl ( _
    enUrlType As UCC_CONTACT_CARD_URL_TYPE _
) As UccPresenceContactCardUrl

UccPresenceContactCardUrl CreateUrl (
    UCC_CONTACT_CARD_URL_TYPE enUrlType
)

UccPresenceContactCardUrl^ CreateUrl (
    UCC_CONTACT_CARD_URL_TYPE enUrlType
)

UccPresenceContactCardUrl CreateUrl (
    UCC_CONTACT_CARD_URL_TYPE enUrlType
)

function CreateUrl (
    enUrlType : UCC_CONTACT_CARD_URL_TYPE
) : UccPresenceContactCardUrl

Parameters

Return Value

A value of the IUccPresenceContactCardUrl** (IUccPresenceContactCardUrl, for a .NET application) type. An application can then set the Url property on the returned IUccPresenceContactCardUrl object before adding it this contact card.

Remarks

The URL is used to indicate the origin of this contact card.

Win32 COM/C++ Syntax

HRESULT CreateUrl
(
   UCC_CONTACT_CARD_URL_TYPE enUrlType,
   IUccPresenceContactCardUrl** ppUrl
);

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 takes parameter of, UCC_CONTACT_CARD_URL_TYPE creates a new instance of UccPresenceContactCardUrl, and returns the created instance to calling code. The new instance must be added to the presence contact card Url collection before it is published. An instance is added to the collection with a call into AddUrl

/// <summary>
/// Creates a new instance of UccPresenceContactCardUrl. 
/// </summary>
/// <param name="pUrlType">UCC_CONTACT_CARD_URL_TYPE enumeration</param>
/// <returns>UccPresenceContactCardPhone of specified type</returns>
public UccPresenceContactCardUrl CreateNewUrlObject(UCC_CONTACT_CARD_URL_TYPE pUrlType)
{
   UccPresenceContactCardUrl returnValue = null;
   try
   {
      returnValue = this._ContactCard.CreateUrl(pUrlType);
   }
   catch (COMException)
   {
   }
   return returnValue;
}

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