IUccPresenceContactCardInstance.Identity 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 the identify of this contact card.

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

Syntax

'Declaration
ReadOnly Property Identity As UccPresenceContactCardIdentity

UccPresenceContactCardIdentity Identity { get; }

property UccPresenceContactCardIdentity^ Identity {
    UccPresenceContactCardIdentity^ get ();
}

/** @property */
UccPresenceContactCardIdentity get_Identity ()

function get Identity () : UccPresenceContactCardIdentity

Property Value

A value of the IUccPresenceContactCardIdentity** (IUccPresenceContactCardIdentity, for a .NET application) type. The identity includes the contact's name or e-mail addresses.

Remarks

The Identity property is used to identify the user described by this contact card. If an un-initialzed instance of this property is accessed, the interface throws a COM exception. It is a good idea to enclose a reference to this property in a try/catch block where exceptions of the COMException type are caught.

Win32 COM/C++ Syntax

HRESULT get_Identity
(
   IUccPresenceContactCardIdentity** ppIdentity
);

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 Identity property is read and cast to an instance of IUccPresenceContactCardIdentity. The exposed DisplayName property string value is added to the StringBuilder instance and finally, the updated StringBuilder is returned to calling code.

/// <summary>
/// Returns an updated StringBuilder instance. contact card Identity 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 GetIdentity(StringBuilder sb, IUccPresenceContactCardInstance pCard)
{
   // raises COM exception
   try
   {
      IUccPresenceContactCardIdentity cardIdentity = this._ContactCard.Identity;
      sb.Append(this._ContactCard.Identity.DisplayName);
   }
   catch (COMException)
   {
   }
   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