IUccPresenceNoteData.Type 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 note type.

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

Syntax

'Declaration
ReadOnly Property Type As UCC_PRESENCE_NOTE_TYPE

UCC_PRESENCE_NOTE_TYPE Type { get; }

property UCC_PRESENCE_NOTE_TYPE Type {
    UCC_PRESENCE_NOTE_TYPE get ();
}

/** @property */
UCC_PRESENCE_NOTE_TYPE get_Type ()

function get Type () : UCC_PRESENCE_NOTE_TYPE

Property Value

A value of the UCC_PRESENCE_NOTE_TYPE* (UCC_PRESENCE_NOTE_TYPE, for a .NET application) type.

Remarks

Win32 COM/C++ Syntax

HRESULT get_Type
(
   UCC_PRESENCE_NOTE_TYPE* penType
);

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). The example public property returns a string that combines the contents of all personal notes in the instance note collection.

/// <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

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