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

Removes all data from this contact card.

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

Syntax

'Declaration
Sub RemoveAllData

void RemoveAllData ()

void RemoveAllData ()

void RemoveAllData ()

function RemoveAllData ()

Remarks

RemoveAllData clears all of the contact card instance collection properties of items, however each collection itself is not null. Single value string properties such as Department are nulled. The Boolean IsAutomaton is set to a false value. Attempting to reference one of the nulled properties results in a NullReferenceException. However, client code can re-initialize a nulled property by setting a new value.

Win32 COM/C++ Syntax

HRESULT RemoveAllData
(
);

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 returns a true value if the contact card instance collections have been emptied, string properties nulled, and the boolean property set to a false value.

/// <summary>
/// empties all contact card collections and nulls all single value properties
/// </summary>
/// <returns>true if all values empty or null</returns>
public Boolean RemoveAllData()
{
   Boolean returnValue = false;
   try
   {
      this._ContactCard.RemoveAllData();
      if (this._ContactCard.Addresses.Count == 0&& 
         this._ContactCard.Phones.Count == 0 && 
         this._ContactCard.Urls.Count == 0  &&
         this._ContactCard.Company == null &&
         this._ContactCard.Department == null &&
         this._ContactCard.OfficeLocation == null &&
         this._ContactCard.Title == null &&
         this._ContactCard.IsAutomaton == false)
      {
         returnValue = true;
      }
   }
   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