Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
.gif)
| Previous | Next |
IWMSBasicPlugin::ShutdownPlugin
The server calls the ShutdownPlugin method to shut down the plug-in.
Syntax
HRESULT ShutdownPlugin();
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.
Example Code
STDMETHODIMP CPlugin::ShutdownPlugin()
{
HRESULT hr = S_OK;
// TODO: Add code that must execute when the
// plug-in is released. For example, release
// any pointers on which the plug-in called
// AddRef().
if( NULL != m_pServer )
{
m_pServer->Release();
m_pServer = NULL;
}
if( NULL != m_pNamedValues )
{
m_pNamedValues->Release();
m_pNamedValues = NULL;
}
return( hr );
}
Requirements
Header: wmsbasicplugin.h.
Library: WMSServerTypeLib.dll.
Platform: Windows Server 2003, Enterprise Edition; Windows Server 2003, Datacenter Edition; Windows Server 2008.
See Also
| Previous | Next |