This documentation is archived and is not being maintained.

IUccPresenceContactCardIdentity.DisplayName 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 display name of a contact.

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

string DisplayName { get; }
/** @property */
String get_DisplayName ()

function get DisplayName () : String

Property Value

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

The DisplayName property is set by the publishing user and is not authenticated against an AD store. For this reason, the DisplayName can be any value.

Win32 COM/C++ Syntax

HRESULT get_DisplayName
(
   BSTR* pName
);
Cc702736.note(en-us,office.12).gifNote:
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.

The following example obtains an instance of IUccPresenceContactCardIdentity from the IUccPresenceContactCardInstance instance (this._ContactCard) wrapped by the application class this example is drawn from. A possible COMException is trapped by a try/catch block in the event the contact card instance Identity property is not initialized.

/// <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 user identity</param>
/// <returns>updated StringBuilder instance</returns>
private StringBuilder GetIdentity(StringBuilder sb, IUccPresenceContactCardInstance pCard)
{
    // raises COM exception
    try
    {
        if (this._ContactCard.Identity != null)
        {
            IUccPresenceContactCardIdentity cardIdentity = this._ContactCard.Identity;

            sb.Append("Display Name: " + cardIdentity.DisplayName);
            foreach (string emailAddress in cardIdentity.EmailAddresses)
            {
                sb.Append("Email Address: " + emailAddress);
            }
        }
    }
    catch (COMException)
    {
    }
    return sb;
}

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

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

Show: