IUccPresenceContactCardInstance.AddPhone 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.

Adds a phone entry to the contact card.

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

Syntax

'Declaration
Sub AddPhone ( _
    pPhone As UccPresenceContactCardPhone _
)

void AddPhone (
    UccPresenceContactCardPhone pPhone
)

void AddPhone (
    UccPresenceContactCardPhone^ pPhone
)

void AddPhone (
    UccPresenceContactCardPhone pPhone
)

function AddPhone (
    pPhone : UccPresenceContactCardPhone
)

Parameters

Remarks

This method adds a new phone instance to a collection if a phone of that type does not exist in the collection. Otherwise, the new phone replaces the existing phone.

Win32 COM/C++ Syntax

HRESULT AddPhone
(
   IUccPresenceContactCardPhone* pPhone
);

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 example below is a public method exposed by a client application class that wraps an instance of IUccPresenceContactCardInstance. It is a good idea to create an instance of such a class for each contact the local user subscribes to.

/// <summary>
/// Adds a UccPresenceContactCardPhone instance to the phones collection of
/// an IUccPresenceContactCardInstance
/// </summary>
/// <param name="pPhone">UccPresenceContactCardPhone to add</param>
/// <returns>boolean value indicating success or failure</returns>
public Boolean AddPhoneObject(UccPresenceContactCardPhone pPhone)
{
   Boolean returnValue = false;
   if (pPhone != null)
   {
      try
      {
         this._ContactCard.AddPhone(pPhone);
         returnValue = true;
      }
      catch
      { }
   }
   else
   {
      throw new ArgumentNullException(
         "An instance of UccPresenceContactCardPhone must be provided");
   }
   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