LogProvider Class

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

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.

public ref class LogProvider sealed : Microsoft::SqlServer::Dts::Runtime::DtsObject, IDisposable, Microsoft::SqlServer::Dts::Runtime::IDTSExecutionPath, Microsoft::SqlServer::Dts::Runtime::IDTSName, Microsoft::SqlServer::Dts::Runtime::IDTSObjectHost, Microsoft::SqlServer::Dts::Runtime::IDTSPackagePath, Microsoft::SqlServer::Dts::Runtime::IDTSPersist, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProvider, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProviderEx, System::ComponentModel::IComponent

public sealed class LogProvider : Microsoft.SqlServer.Dts.Runtime.DtsObject, IDisposable, Microsoft.SqlServer.Dts.Runtime.IDTSExecutionPath, Microsoft.SqlServer.Dts.Runtime.IDTSName, Microsoft.SqlServer.Dts.Runtime.IDTSObjectHost, Microsoft.SqlServer.Dts.Runtime.IDTSPackagePath, Microsoft.SqlServer.Dts.Runtime.IDTSPersist, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProvider, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProviderEx, System.ComponentModel.IComponent

type LogProvider = class
    inherit DtsObject
    interface IDTSObjectHost
    interface IDTSName
    interface IDTSPersist
    interface IDTSPropertiesProvider
    interface IDTSPropertiesProviderEx
    interface IComponent
    interface IDisposable
    interface IDTSPackagePath
    interface IDTSExecutionPath

Public NotInheritable Class LogProvider
Inherits DtsObject
Implements IComponent, IDisposable, IDTSExecutionPath, IDTSName, IDTSObjectHost, IDTSPackagePath, IDTSPersist, IDTSPropertiesProvider, IDTSPropertiesProviderEx

Inheritance

Object

DtsObject

LogProvider

Implements

IDTSExecutionPath IDTSName IDTSObjectHost IDTSPackagePath IDTSPersist IDTSPropertiesProvider IDTSPropertiesProviderEx IComponent IDisposable

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.

Properties

ConfigString	Gets or sets the connection and configuration information for the specific log provider.
CreationName	Returns the string used by the runtime to create an instance of the LogProvider object. This property is read-only.
DelayValidation	Gets or sets a Boolean that specifies whether a call to Validate(IDTSInfoEvents) for the log provider is delayed until package execution.
Description	Gets or sets the description of the LogProvider object.
HasExpressions	Gets or sets a value that indicates whether the log provider has expressions.
HostType	Gets an enumeration that describes the type of host that the log provider is being used by. This property is read-only
ID	Gets the ID of the LogProvider. This property is read-only.
InnerObject	Returns the specific log provider that is being hosted by the LogProvider object.
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.
Properties	Returns a DtsProperties collection, which contains a collection of DtsProperty objects.
Site	Gets or sets the site for the log provider.

Methods

CloseLog()	Closes the log.
Dispose()	Releases the resources used by the log provider.
Equals(Object)	Determines whether two object instances are equal. (Inherited from DtsObject)
GetExecutionPath()	Returns a String that contains the execution path of the log provider.
GetExpression(String)	Returns a String that contains the expression for the specified property. Null means no expression is assigned.
GetHashCode()	Returns the hash code for this instance. (Inherited from DtsObject)
GetPackagePath()	Returns a String that contains the relative path to the package location.
LoadFromXML(XmlNode, IDTSEvents)	This method is not callable by your application code. To load a package saved as .xml, use the LoadPackage(String, IDTSEvents) method.
OpenLog()	Opens the log.
SaveToXML(XmlDocument, XmlNode, IDTSEvents)	This method is not callable by your application code. To save a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.
SetExpression(String, String)	Assigns the specified expression to the property. Specify null to remove an existing expression from the property.

Events

Disposed

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