This documentation is archived and is not being maintained.

_IUccInstantMessagingSessionParticipantEvents.OnIdle 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.

Raised when the participant stops composing a message.

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

void OnIdle (
	UccInstantMessagingSessionParticipant pEventSource,
	UccInstantMessagingComposingEvent pEventData
)
void OnIdle (
	UccInstantMessagingSessionParticipant pEventSource, 
	UccInstantMessagingComposingEvent pEventData
)
function OnIdle (
	pEventSource : UccInstantMessagingSessionParticipant, 
	pEventData : UccInstantMessagingComposingEvent
)

Parameters

pEventSource

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

pEventData

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

In order to raise the OnIdle event on a remote partcipant endpoint, the local participant must call StopComposing 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 OnIdle
(
   IUccInstantMessagingSessionParticipant* pEventSource,
   IUccInstantMessagingComposingEvent* pEventData
);
Cc667646.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 StopComposing.

/// <summary>
/// raised when a remote session participant is no longer composing
/// </summary>
/// <param name="pEventSource">IUccInstantMessagingSessionParticipant remote participant</param>
/// <param name="pEventData">IUccInstantMessagingComposingEvent event data</param>
void _IUccInstantMessagingSessionParticipantEvents.OnIdle(
     UccInstantMessagingSessionParticipant pEventSource, 
    UccInstantMessagingComposingEvent pEventData)
{
    Console.WriteLine(
        pEventData.ParticipantEndpoint.Participant.Uri.User + " 
        has stopped composing");
}

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: