• Article

LoggingOptions Class

Contains members that regulate what information is included or excluded from logging. This class cannot be inherited.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.LoggingOptions

Namespace:  Microsoft.SqlServer.Dts.Runtime
Assembly:  Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

Syntax

'Declaration
Public NotInheritable Class LoggingOptions _
    Inherits DtsObject _
    Implements IDTSPersist
'Usage
Dim instance As LoggingOptions

public sealed class LoggingOptions : DtsObject, 
    IDTSPersist

public ref class LoggingOptions sealed : public DtsObject, 
    IDTSPersist

[<SealedAttribute>]
type LoggingOptions =  
    class
        inherit DtsObject
        interface IDTSPersist
    end

public final class LoggingOptions extends DtsObject implements IDTSPersist

The LoggingOptions type exposes the following members.

Properties

  Name Description
Public property EventFilter Gets or sets an array that contains the names of the events that are the subject of the filtering options.
Public property EventFilterKind Gets or sets a value that describes the kind of event filter that is set, whether included or excluded.
Public property SelectedLogProviders A collection of log providers selected on the container. A log provider can only be selected for a container when the container's LoggingMode is set to Enabled.

Top

Methods

  Name Description
Public method Equals Determines whether two object instances are equal. (Inherited from DtsObject.)
Protected method Finalize (Inherited from Object.)
Public method GetColumnFilter Returns column filter for the specified event.
Public method GetColumnFilteredEvents Returns a string array that contains a list of events that have a column filter set.
Public method GetHashCode Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetType (Inherited from Object.)
Public method LoadFromXML This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
Protected method MemberwiseClone (Inherited from Object.)
Public method SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Public method SetColumnFilter Sets column filter for the specified event.
Public method ToString (Inherited from Object.)

Top

Remarks

Logging options add a filtering capability to restrict logging output to only those items you are interested in, which reduces impact on the system in terms of performance. Logging is meant for diagnostic and analytic usage, rather than progress tracking.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.