Share via

IWMSLoggingAdmin.LoggedEvents (C#)

  • Article

banner art

Previous Next

IWMSLoggingAdmin.LoggedEvents (C#)

The LoggedEvents property specifies and retrieves an enumeration value indicating the type of transmission for which events are logged.

Syntax

  IWMSLoggingAdmin
  .LoggedEvents = WMS_LOG_EVENT_TYPE;
WMS_LOG_EVENT_TYPE = IWMSLoggingAdmin.LoggedEvents;

Property Value

A member of the WMS_LOG_EVENT_TYPE enumeration type indicating the type of transmission for which events are logged. This must be an exclusive OR of the following values.

Value Description
WMS_LOG_EVENT_DISTRIBUTION Events are logged for a distribution server.
WMS_LOG_EVENT_FILTER_ON_ROLE Events with a certain role attribute are logged
WMS_LOG_EVENT_LOCAL Events are logged for local connections.
WMS_LOG_EVENT_NONE Events are not logged.
WMS_LOG_EVENT_PLAYER Events are logged for client connections.
WMS_LOG_EVENT_REMOTE Events are logged for remote connections.

If this property fails, it throws an exception.

Number Description
0x80004005 The server cannot find the WMS Client Logging plug-in.
0x80070057 The value you specified is not a member of the WMS_LOG_EVENT_TYPE enumeration type.

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;
}
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