Share via


LogProvider Class

Contains information about a log provider associated with a package. All log providers associated with a package are located in the LogProviders collection. For log providers on the computer, use the Application class and view the LogProviderInfos collection. This class cannot be inherited.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public NotInheritable Class LogProvider _
    Inherits DtsObject _
    Implements IDTSObjectHost, IDTSName, IDTSPersist, IDTSPropertiesProvider,  _
    IComponent, IDisposable, IDTSPackagePath
'Usage
Dim instance As LogProvider
public sealed class LogProvider : DtsObject, 
    IDTSObjectHost, IDTSName, IDTSPersist, IDTSPropertiesProvider, IComponent, 
    IDisposable, IDTSPackagePath
public ref class LogProvider sealed : public DtsObject, 
    IDTSObjectHost, IDTSName, IDTSPersist, IDTSPropertiesProvider, IComponent, 
    IDisposable, IDTSPackagePath
[<SealedAttribute>]
type LogProvider =  
    class
        inherit DtsObject
        interface IDTSObjectHost
        interface IDTSName
        interface IDTSPersist
        interface IDTSPropertiesProvider
        interface IComponent
        interface IDisposable
        interface IDTSPackagePath
    end
public final class LogProvider extends DtsObject implements IDTSObjectHost, IDTSName, IDTSPersist, IDTSPropertiesProvider, IComponent, IDisposable, IDTSPackagePath

The LogProvider type exposes the following members.

Properties

  Name Description
Public property ConfigString Gets or sets the connection and configuration information for the specific log provider.
Public property CreationName Returns the string used by the runtime to create an instance of the LogProvider object. This property is read-only.
Public property DelayValidation Gets or sets a Boolean that specifies whether a call to Validate for the log provider is delayed until package execution.
Public property Description Gets or sets the description of the LogProvider object.
Public property HostType Gets an enumeration that describes the type of host that the log provider is being used by. This property is read-only
Public property ID Gets the ID of the LogProvider. This property is read-only.
Public property InnerObject Returns the specific log provider that is being hosted by the LogProvider object.
Public property Name Gets or sets a the name of the LogProvider object, such as "SSIS log provider for Text files". This string is the text that shows in the Configure SSIS Logs (Providers and Logs Tab) dialog box in the Provider type drop-down menu.
Public property Properties Returns a DtsProperties collection, which contains a collection of DtsProperty objects.
Public property Site Infrastructure.

Top

Methods

  Name Description
Public method CloseLog Closes the log.
Public method Dispose Releases the resources used by the log provider.
Public method Equals Determines whether two object instances are equal. (Inherited from DtsObject.)
Protected method Finalize (Inherited from Object.)
Public method GetExpression Returns a String that contains the expression for the specified property. Null means no expression is assigned.
Public method GetHashCode Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetPackagePath Returns a String that contains the relative path to the package location.
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 OpenLog Opens the log.
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 SetExpression Assigns the specified expression to the property. Specify nulla null reference (Nothing in Visual Basic) to remove an existing expression from the property.
Public method ToString (Inherited from Object.)

Top

Events

  Name Description
Public event Disposed Adds an event handler to listen to the Disposed event on the log provider.

Top

Remarks

The host log provider is a class that provides the methods and properties that are common to all of the log providers. Regardless of which log provider is in use, this class allows you to perform all tasks associated with logging. The LogProvider class is the object you use when programmatically adding log providers to a package. It is a generic host log provider that hosts an underlying log provider. The hosted log provider is accessible using the InnerObject. If you want to create a custom log provider, use the LogProviderBase class.

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.