IUccPresenceNoteInstance.RemoveNote 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 a note.

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

Syntax

'Declaration
Sub RemoveNote ( _
    pNote As UccPresenceNoteData _
)

void RemoveNote (
    UccPresenceNoteData pNote
)

void RemoveNote (
    UccPresenceNoteData^ pNote
)

void RemoveNote (
    UccPresenceNoteData pNote
)

function RemoveNote (
    pNote : UccPresenceNoteData
)

Parameters

• pNote
  A value of the IUccPresenceNoteData* (UccPresenceNoteData, for a .NET application) type.

Remarks

Win32 COM/C++ Syntax

HRESULT RemoveNote
(
   IUccPresenceNoteData* pNote
);

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 method is drawn from an application class that wraps an instance of IUccPresenceNoteInstance (this._Note). While a client can simply refer to the first instance of a note in a collection (this.Note.Notes[1]), the example must find the first note of a specified type. For this reason, the note collection is iterated over to find the first note of a type.

/// <summary>
/// iterates on ALL notes in collection to find the first instance
/// of a note of the specified type. When first matching instance
///  is found, it is deleted
/// </summary>
/// <param name="noteType">UCC_PRESENCE_NOTE_TYPE note type to remove</param>
/// <returns>true if note is deleted</returns>
public Boolean RemoveFirstNote(UCC_PRESENCE_NOTE_TYPE noteType)
{
    Boolean returnValue = false;
    try
    {
        foreach (UccPresenceNoteData noteData in this._Note.Notes)
        {
            if (noteData.Type == noteType)
            {
                this._Note.RemoveNote(noteData);
                returnValue = true;
                break;
            }
        }
    }
    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