IUccPresenceContactCardInstance.CreatePhone Method

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 phone entry to be added to this contact card.

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

Syntax

'Declaration
Function CreatePhone ( _
    enPhoneType As UCC_CONTACT_CARD_PHONE_TYPE _
) As UccPresenceContactCardPhone

UccPresenceContactCardPhone CreatePhone (
    UCC_CONTACT_CARD_PHONE_TYPE enPhoneType
)

UccPresenceContactCardPhone^ CreatePhone (
    UCC_CONTACT_CARD_PHONE_TYPE enPhoneType
)

UccPresenceContactCardPhone CreatePhone (
    UCC_CONTACT_CARD_PHONE_TYPE enPhoneType
)

function CreatePhone (
    enPhoneType : UCC_CONTACT_CARD_PHONE_TYPE
) : UccPresenceContactCardPhone

Parameters

• enPhoneType
  A value of the UCC_CONTACT_CARD_PHONE_TYPE type. This specifies the type of the new phone entry.

Return Value

A value of the IUccPresenceContactCardPhone** (IUccPresenceContactCardPhone, for a .NET application) type. The caller can then set the display and phone number (URL) on the returned phone entry before adding it to this contact card.

Remarks

A phone entry in a contact card consists of the display names and URL of the phone. It also includes a phone type.

Win32 COM/C++ Syntax

HRESULT CreatePhone
(
   UCC_CONTACT_CARD_PHONE_TYPE enPhoneType,
   IUccPresenceContactCardPhone** ppPhone
);

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_PHONE_TYPE, creates a new instance of UccPresenceContactCardPhone, and returns the created instance to calling code. The new instance must be added to the presence contact card phones collection before it is published. An instance is added to the collection with a call into AddPhone

/// <summary>
/// Creates a new instance of UccPresenceContactCardPhone. 
/// </summary>
/// <param name="pPhoneType">UCC_CONTACT_CARD_PHONE_TYPE enumeration</param>
/// <returns>UccPresenceContactCardPhone of specified type</returns>
public UccPresenceContactCardPhone CreateNewPhoneObject(UCC_CONTACT_CARD_PHONE_TYPE pPhoneType)
{
   UccPresenceContactCardPhone returnValue = null;
   try
   {
      returnValue = this._ContactCard.CreatePhone(pPhoneType);
   }
   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