IWMSBasicPlugin.DisablePlugin (Visual Basic .NET)

  • Article

banner art

Previous Next

IWMSBasicPlugin.DisablePlugin (Visual Basic .NET)

The server calls the DisablePlugin method to disable a plug-in.

Syntax

Parameters

This method takes no parameters.

Return Values

This method does not return a value. 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.

Remarks

This method is implemented by the plug-in and called by the server. When a user disables the plug-in by using the Windows Media Services MMC, the server calls this method. You can also force the server to disable a plug-in by setting the IWMSPlugin.Enabled property to False. Finally, the server calls DisablePlugin before calling IWMSBasicPlugin.ShutdownPlugin.

  • Note   The server can call the DisablePlugin method even though the Enabled property on the IWMSPlugin object is True. For example, if the IWMSEventLog.LogEvent method is used to log an event of type WMS_EVENT_LOG_LEVEL_ERROR, the server will call DisablePlugin without resetting the Enabled property from True to False.

Example Code

Public Overloads Sub DisablePlugin() _
    Implements IWMSBasicPlugin.DisablePlugin

    ' Set an internal data member to indicate that the plug-in
    ' is not enabled.
    m_bEnabled = False
End Sub

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