IWMSLoggingAdmin.Dirty (Visual Basic .NET)

Previous

Next

IWMSLoggingAdmin.Dirty (Visual Basic .NET)

The Dirty property retrieves a Boolean value indicating whether the currently running configuration is different from the stored configuration.

Syntax

  Boolean =
  
  LoggingAdmin
  .Dirty

Property Value

A Boolean indicating whether the currently running profile is different from the stored profile.

If this property fails, it throws an exception.

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

Remarks

If a property is modified while the plug-in is enabled, this flag is set to TRUE. When this flag is set, the plug-in's currently running profile is different from the stored profile, and the changes will be applied when the plug-in is re-enabled. When a log is cycled or changes from disabled to enabled, the stored configuration is applied to the plug-in and this flag is cleared.

When this flag is TRUE, the plug-in's properties reflect the currently running instance of the plug-in. They do not reflect the stored configuration.

This property is read only.

Example Code

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

Private Sub CycleLog()

    ' 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

    ' Retrieve a Boolean value indicating
    ' whether the log needs to be cycled
    ' in order to use new configuration options.
    If LogAdmin.Dirty = True Then
        LogAdmin.CycleNow()
    End If

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

• IWMSLoggingAdmin Object (Visual Basic .NET)

Previous

Next