IUccPresenceNoteInstance.Notes Property

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.

Gets the collection of the notes.

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

Syntax

'Declaration
ReadOnly Property Notes As IUccCollection

IUccCollection Notes { get; }

property IUccCollection^ Notes {
    IUccCollection^ get ();
}

/** @property */
IUccCollection get_Notes ()

function get Notes () : IUccCollection

Property Value

A value of the IUccCollection** (IUccCollection, for a .NET application) type. Each element of the collection is an IUccPresenceNoteData object.

Remarks

The Notes collection can hold any number of individual notes regardless of the type assigned to a note. For instance, a Notes collection can hold any number of notes of the UCC_PRESENCE_NOTE_TYPE.UCCPNT_PERSONAL type.

Win32 COM/C++ Syntax

HRESULT get_Notes
(
   IUccCollection** ppNotes
);

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 a public property of an application class that wraps an instance of IUccPresenceNoteInstance (this._Note). The get accesor iterates on the Notes collection of the note instance and appends a StringBuilder instance with the note content of each personal note it finds in the collection. Finally, the accumulated personal notes are returned as a string.

/// <summary>
/// returns a string filled with the note item defined as 
/// a personal note
/// </summary>
public string PersonalNoteText
{
   get
   {
      StringBuilder sb = new StringBuilder();
      foreach (IUccPresenceNoteData noteData in this._Note.Notes)
      {
         if (noteData.Type == UCC_PRESENCE_NOTE_TYPE.UCCPNT_PERSONAL)
         {
            sb.Append(noteData.Content.String);
            sb.Append(System.Environment.NewLine);
         }
      }
      return sb.ToString();
   }
}

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