IWMSBasicPlugin::DisablePlugin
Previous | Next |
IWMSBasicPlugin::DisablePlugin
The server calls the DisablePlugin method to disable a plug-in.
Syntax
HRESULT DisablePlugin();
Parameters
This method takes no parameters.
Return Values
If the method succeeds, the plug-in must return S_OK. To report an error, the plug-in can return any HRESULT other than S_OK. If the plug-in uses the IWMSEventLog interface to log error information directly to the Windows Event Viewer, it is recommended that it return NS_E_PLUGIN_ERROR_REPORTED. 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 interface to send custom error information to the Windows Event Viewer, returning NS_E_PLUGIN_ERROR_REPORTED stops the server from also logging to the event viewer. For more information about retrieving plug-in error information, see Identifying Plug-in Errors.
Remarks
This method is implemented by the plug-in and called by the server. The minimum implementation returns S_OK. 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 calling IWMSPlugin::put_Enabled and setting the parameter to VARIANT_FALSE. Finally, the server calls DisablePlugin before calling IWMSBasicPlugin::ShutdownPlugin.
- Note The server can call the DisablePlugin method even though the Enable property on the IWMSPlugin interface 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 Enable property from True to False.
Example Code
STDMETHODIMP CPlugin::DisablePlugin() { // Set an internal data member to indicate that the plug-in // is not enabled. m_fPluginEnabled = FALSE; return ( S_OK ); }
Requirements
Header: wmsbasicplugin.h.
Library: WMSServerTypeLib.dll.
Platform: Windows Server 2003, Enterprise Edition; Windows Server 2003, Datacenter Edition; Windows Server 2008.
See Also
- IWMSBasicPlugin Interface
- IWMSBasicPlugin::EnablePlugin
- IWMSBasicPlugin::ShutdownPlugin
- IWMSPlugin::put_Enabled
- WMS_EVENT_LOG_LEVEL
Previous | Next |