Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

_IUccInstantMessagingSessionParticipantEvents.OnComposing Method

Raised when a remote participant is composing a message.

Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)
void OnComposing (
	UccInstantMessagingSessionParticipant pEventSource,
	UccInstantMessagingComposingEvent pEventData
)
void OnComposing (
	UccInstantMessagingSessionParticipant pEventSource, 
	UccInstantMessagingComposingEvent pEventData
)
function OnComposing (
	pEventSource : UccInstantMessagingSessionParticipant, 
	pEventData : UccInstantMessagingComposingEvent
)

Parameters

pEventSource

A value of the IUccInstantMessagingSessionParticipant* (UccInstantMessagingSessionParticipant, for a .NET application) type. This identifies the IM participant composing the message.

pEventData

A value of the IUccInstantMessagingComposingEvent* (UccInstantMessagingComposingEvent, for a .NET application) type. This contains the information about the participant endpoint engaged in composing a message.

In order to raise the OnComposing event on a remote partcipant endpoint, the local participant must call StartComposing on the IUccInstantMessagingSession instance. After a participant has called into StartComposing, that participant is considered to be composing until a call into StopComposing is made. After a participant has called into StopComposing, the other session participant receives the OnIdle event that indicates the composing participant has stopped composing.

Win32 COM/C++ Syntax

HRESULT OnComposing
(
   IUccInstantMessagingSessionParticipant* pEventSource,
   IUccInstantMessagingComposingEvent* pEventData
);
Cc702593.note(en-us,office.12).gifNote:
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 .

The following example displays a message indicating a remote instant messaging session participant has called StartComposing.

/// <summary>
/// raised when a remote session participant is composing
/// </summary>
/// <param name="pEventSource">IUccInstantMessagingSessionParticipant remote participant</param>
/// <param name="pEventData">IUccInstantMessagingComposingEvent event data</param>
void _IUccInstantMessagingSessionParticipantEvents.OnComposing(
    UccInstantMessagingSessionParticipant pEventSource, 
    UccInstantMessagingComposingEvent pEventData)
{
    Console.WriteLine(
        pEventData.ParticipantEndpoint.Participant.Uri.User + 
        " is composing " + 
        pEventSource.ComposingContentType);
    
}
All public static (Shared in Visual Basic) members of this type are thread-safe. Instance members are not guaranteed to be thread-safe.

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

Show:
© 2014 Microsoft. All rights reserved.