Share via

IWMSLoggingAdmin.RoleFilter (Visual Basic .NET)

  • Article

banner art

Previous Next

IWMSLoggingAdmin.RoleFilter (Visual Basic .NET)

The RoleFilter property specifies and retrieves the name of the role attribute that will be used when filtering logged events.

Syntax

  IWMSLoggingAdmin
  .RoleFilter = String
String = IWMSLoggingAdmin.RoleFilter

Property Value

A String containing the name of the role attribute to use when filtering logged events.

If this property fails, it throws an exception.

Number Description
0x80004005 The server cannot find the WMS Client Logging plug-in.

Example Code

Imports Microsoft.WindowsMediaServices.Interop
Imports System.Runtime.InteropServices

Private Sub SetFilter()

    ' Declare variables.
    Dim Server As WMSServer
    Dim Plugin As IWMSPlugin
    Dim LogAdmin As IWMSLoggingAdmin

Try
    ' Create the WMSServer object.
    Server = New WMSServer()

    ' Retrieve the plug-in to be configured.
    Plugin = Server.EventHandlers.Item("WMS Client Logging")

    ' Retrieve the custom interface of the plug-in.
    LogAdmin = Plugin.CustomInterface

    ' Configure the plug-in to log only events that
    ' fulfill certain requirements.
    LogAdmin.LoggedEvents = _
         WMS_LOG_EVENT_TYPE.WMS_LOG_EVENT_PLAYER Or _
         WMS_LOG_EVENT_TYPE.WMS_LOG_EVENT_LOCAL Or _
         WMS_LOG_EVENT_TYPE.WMS_LOG_EVENT_FILTER_ON_ROLE

    ' Configure the filter so that only content with
    ' an 'advertisement' role gets logged.
    LogAdmin.RoleFilter = "Advertisement"

Catch excCom As COMException
    ' TODO: Handle COM exceptions.
Catch exc As Exception
    ' TODO: Handle errors.
Finally
    ' TODO: Clean-up code goes here.
End Try

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 family, Windows Server 2008 family.

See Also

Previous Next