IWMSLoggingAdmin.Flush (Visual Basic .NET)

IWMSLoggingAdmin.Flush (Visual Basic .NET)

The Flush method causes all data currently in the buffer to be flushed to the log file.

Syntax

  IWMSLoggingAdmin
  .Flush()

Parameters

This method takes no parameters.

Return Values

This method does not return a value.

If this method fails, it throws an exception.

Remarks

The Flush method is only effective when buffering is in use.

Example Code

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

Private Sub FlushToLog()

    ' 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

    ' Flush all unwritten data to the
    ' log file immediately.
    LogAdmin.Flush()

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)
• IWMSLoggingAdmin.UseBuffering (Visual Basic .NET)