IUccPresenceNoteInstance.RemoveAllNotes 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 notes.

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

Syntax

'Declaration
Sub RemoveAllNotes

void RemoveAllNotes ()

void RemoveAllNotes ()

void RemoveAllNotes ()

function RemoveAllNotes ()

Remarks

Removes all IUccPresenceNoteData instances from the Notes collection exposed by the IUccPresenceNoteInstance. The collection itself is not nulled.

Win32 COM/C++ Syntax

HRESULT RemoveAllNotes
(
);

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 is drawn from an application class that wraps an instance of IUccPresenceNoteInstance (this._Note).

/// <summary>
/// removes all IUccPresenceNoteData instances from the Notes collection
/// </summary>
/// <returns>true if </returns>
public Boolean RemoveAllNotes()
{
    Boolean returnValue = false;
    try
    {
        this._Note.RemoveAllNotes();
        if (this._Note.Notes.Count == 0)
        {
            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

IUccPresenceNoteInstance Interface
IUccPresenceNoteInstance Members
Microsoft.Office.Interop.UccApi Namespace