IWMSBasicPlugin.GetCustomAdminInterface (Visual Basic .NET)

  • Article

banner art

Previous Next

IWMSBasicPlugin.GetCustomAdminInterface (Visual Basic .NET)

The server calls the GetCustomAdminInterface method to retrieve the administration object of a plug-in.

Syntax

Parameters

This method takes no parameters.

Return Values

This method returns an Object containing the custom administration user interface. 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

An administration object enables you to specify and retrieve the properties of a plug-in. Typically, an administration object is used in conjunction with MMC or ASP property pages. For more information, see Creating an MMC Property Page or Creating an ASP Property Page.

The server calls the GetCustomAdminInterface method when the plug-in is created and when the IWMSPlugin.CustomInterface method is called. The minimum implementation returns Nothing.

Example Code

Public Overloads Function GetCustomAdminInterface() As Object _
    Implements IWMSBasicPlugin.GetCustomAdminInterface

    Return Nothing
End Function

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