IUccPresenceContactCardIdentity.DisplayName Property
Gets the display name of a contact.
Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)
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 );
 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. |
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;
}
