Share via

IWMSLoggingAdmin.RoleFilter (C#)

  • Article

banner art

Previous Next

IWMSLoggingAdmin.RoleFilter (C#)

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

using Microsoft.WindowsMediaServices.Interop;
using System.Runtime.InteropServices;

// Declare variables.
WMSServer Server;
IWMSPlugin Plugin;
IWMSLoggingAdmin LogAdmin;

try {
    // Create a new WMSServer object.
    Server = new WMSServerClass();

    // Retrieve the plug-in to be configured.
    Plugin = Server.EventHandlers[
                        "WMS Client Logging"];

    // Retrieve the custom interface of the plug-in.
    LogAdmin =
        (IWMSLoggingAdmin)Plugin.CustomInterface;

    // Configure the plug-in to log only events that
    // fulfill certain requirements.
    LogAdmin.LoggedEvents = WMS_LOG_EVENT_TYPE.WMS_LOG_EVENT_PLAYER |
                          WMS_LOG_EVENT_TYPE.WMS_LOG_EVENT_LOCAL |
                          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 (COMException comExc) {
    // TODO: Handle COM exceptions.
}
catch (Exception e) {
    // TODO: Handle exceptions.
}

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