Share via

IWMSBasicPlugin::EnablePlugin

  • Article

banner art

Previous Next

IWMSBasicPlugin::EnablePlugin

The server calls the EnablePlugin method to enable a plug-in. This method is called only if the IWMSBasicPlugin::InitializePlugin method succeeds.

Syntax

  HRESULT EnablePlugin(
  long*  plFlags,
  long*  plHeartbeatPeriod
);

Parameters

plFlags

[in, out] Reserved for future use.

plHeartbeatPeriod

[in, out] Pointer to a long specifying the heartbeat interval in milliseconds that is used by the server to call the IWMSBasicPlugin::OnHeartbeat method. A value of zero specifies that OnHeartBeat will not be called.

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. The IWMSBasicPlugin::InitializePlugin and EnablePlugin methods must return S_OK before the server can successfully enable and use the plug-in. When the Enable property on the IWMSPlugin interface is set to True, the EnablePlugin method is called by the server.

Example Code

STDMETHODIMP CPlugin::EnablePlugin( long *plFlags, 
                                       long *pdwHeartbeatPeriod )
{
    // Specify the heartbeat period. A value of zero means 
    // that the server does not call OnHeartbeat().
    *pdwHeartbeatPeriod = 0;

    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

Previous Next