Share via


DMessengerEvents::OnSignout

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.

Called by the API to notify that the user of the local client has signed out. Scriptable.

Syntax

HRESULT OnSignout();

Parameters

None.

Return Value

The implementer of this event handler will determine what value should be returned.

Remarks

This event is used to inform an application that the local client is signing out. It is raised when the user has signed out using a Communicator instance or when the local client application has called the IMessenger::Signout method.

Example

This code example demonstrates the best practice for cleaning up memory resources when non-managed COM objects have been instantiated. When the communicator object has been released, any further automation API calls raise a COM exception.

void communicator_OnSignout()
{
    Console.WriteLine("Local Client has signed out");
    // Release the unmanaged resource.
 System.Runtime.InteropServices.Marshal.ReleaseComObject(communicator);
    communicator = null;
 }

Requirements

  • Client
    Requires Microsoft DirectX 9.0, C Runtime libraries (msvcm80.dll) on Microsoft Windows© Vista, Microsoft Windows XP Service Pack 1 (SP1) or later, or Microsoft Windows 2000 with Service Pack 4 (SP4). Any Communicator-imposed restrictions apply. .
  • Server
    Requires Microsoft Office Communications Server 2007, AV MCU (for Media Support), Media Relay (for NAT/Firewall traversal) on Microsoft Office Communications Server 2007.
  • Product
    Microsoft Office Communicator 2007 Automation API
  • IDL file
    Msgrua.idl

See Also

Reference

DMessengerEvents::OnAppShutdown