IWMSEventNotificationPlugin.GetHandledEvents (C#)

  • Article

banner art

Previous Next

IWMSEventNotificationPlugin.GetHandledEvents (C#)

The server calls the GetHandledEvents method to retrieve an array containing the events that can be handled by the plug-in.

Syntax

  object

Parameters

This method takes no parameters.

Return Values

This method returns an object containing an array of WMS_EVENT_TYPE enumeration values. To report an error, the plug-in can throw a COMException object to the server. If the plug-in uses the IWMSEventLog object to log error information, it is recommended that it throw NS_E_PLUGIN_ERROR_REPORTED (0xC00D157D). Typically, the server attempts to make plug-in error information available to the server object model, the Windows Event Viewer, and the troubleshooting list in the details pane of the Windows Media Services MMC. However, if the plug-in uses the IWMSEventLog object to send custom error information to the Windows Event Viewer, throwing NS_E_PLUGIN_ERROR_REPORTED stops the server from also logging to the event viewer. For more information about plug-in error information, see Identifying Plug-in Errors.

Example Code

public object GetHandledEvents()
{
    // Identify the events the plug-in can respond to.
    WMS_EVENT_TYPE[] wmsEvents = {
                WMS_EVENT_TYPE.WMS_EVENT_PLUGIN,
                WMS_EVENT_TYPE.WMS_EVENT_PUBLISHING_POINT,
                WMS_EVENT_TYPE.WMS_EVENT_SERVER,
                WMS_EVENT_TYPE.WMS_EVENT_LIMIT_CHANGE};

    return wmsEvents;
}

Requirements

Reference: Add a reference to Microsoft.WindowsMediaServices.

Namespace: Microsoft.WindowsMediaServices.Interop.

Assembly: Microsoft.WindowsMediaServices.dll.

Library: WMSServerTypeLib.dll.

Platform: Windows Server 2003, Enterprise Edition; Windows Server 2003, Datacenter Edition; Windows Server 2008.

See Also

Previous Next