IWMSBasicPlugin.EnablePlugin (Visual Basic .NET)

  • Article

banner art

Previous Next

IWMSBasicPlugin.EnablePlugin (Visual Basic .NET)

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

Syntax

Parameters

plFlags

Reserved for future use.

plHeartbeatPeriod

Reference to an Int32 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

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

Example Code

Public Overloads Sub EnablePlugin( _
    ByRef Flags As Integer, _
    ByRef HeartbeatPeriod As Integer) _
    Implements IWMSBasicPlugin.EnablePlugin

    ' Specify the heartbeat period. A value of zero means 
    ' that the server does not call OnHeartbeat().
    HeartbeatPeriod = 0
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