IUccPresenceNoteInstance.CreateNote 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.

Creates a note of a given type.

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

Syntax

'Declaration
Function CreateNote ( _
    enNoteType As UCC_PRESENCE_NOTE_TYPE _
) As UccPresenceNoteData

UccPresenceNoteData CreateNote (
    UCC_PRESENCE_NOTE_TYPE enNoteType
)

UccPresenceNoteData^ CreateNote (
    UCC_PRESENCE_NOTE_TYPE enNoteType
)

UccPresenceNoteData CreateNote (
    UCC_PRESENCE_NOTE_TYPE enNoteType
)

function CreateNote (
    enNoteType : UCC_PRESENCE_NOTE_TYPE
) : UccPresenceNoteData

Parameters

• enNoteType
  A value of the UCC_PRESENCE_NOTE_TYPE type.

Return Value

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

Remarks

An instance of IUccPresenceNoteInstance is a "factory object" that returns new instances of IUccPresenceNoteData that can be added to the Notes collection.

Win32 COM/C++ Syntax

HRESULT CreateNote
(
   UCC_PRESENCE_NOTE_TYPE enNoteType,
   IUccPresenceNoteData** ppNote
);

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 drawn from an application class that wraps an instance of IUccPresenceNoteInstance (this._Note), creates a note, and a locale string, and adds the configured note to the notes collection of the presence note instance.

/// <summary>
/// Creates a new note instance and adds the new instance to the Notes collection
/// of the IUccPresenceNoteInstance 
/// </summary>
/// <param name="content">Note text to add</param>
/// <param name="plcid">Location Id assigned to UccLocaleString instance</param>
/// <param name="noteType">type of note to add</param>
/// <returns></returns>
public Boolean AddNoteText(string content, int plcid ,UCC_PRESENCE_NOTE_TYPE noteType)
{
    Boolean returnValue = false;
    try
    {
        //create a new note
        UccPresenceNoteData newData = this._Note.CreateNote(noteType);

        //use new note to create a UccLocaleSTring
        UccLocaleString localeString = newData.CreateContent();

        //assign note text to locale string
        localeString.String = content;

        //assign locale Id to locale string
        localeString.Lcid = plcid; 

        //assign locale string to note
        newData.Content = localeString;
        this._Note.AddNote(newData);
        returnValue = true;
    }
    catch
    { }
    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