LogProvider Class

Article
04/26/2013

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,  _
    IDTSPropertiesProviderEx, IComponent, IDisposable, IDTSPackagePath, IDTSExecutionPath
'Usage
Dim instance As LogProvider

public sealed class LogProvider : DtsObject, 
    IDTSObjectHost, IDTSName, IDTSPersist, IDTSPropertiesProvider, IDTSPropertiesProviderEx, 
    IComponent, IDisposable, IDTSPackagePath, IDTSExecutionPath

public ref class LogProvider sealed : public DtsObject, 
    IDTSObjectHost, IDTSName, IDTSPersist, IDTSPropertiesProvider, IDTSPropertiesProviderEx, 
    IComponent, IDisposable, IDTSPackagePath, IDTSExecutionPath

[<SealedAttribute>]
type LogProvider =  
    class 
        inherit DtsObject 
        interface IDTSObjectHost 
        interface IDTSName 
        interface IDTSPersist 
        interface IDTSPropertiesProvider 
        interface IDTSPropertiesProviderEx 
        interface IComponent 
        interface IDisposable 
        interface IDTSPackagePath 
        interface IDTSExecutionPath 
    end

public final class LogProvider extends DtsObject implements IDTSObjectHost, IDTSName, IDTSPersist, IDTSPropertiesProvider, IDTSPropertiesProviderEx, IComponent, IDisposable, IDTSPackagePath, IDTSExecutionPath

The LogProvider type exposes the following members.

Properties

	Name	Description
	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 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	Infrastructure. Gets or sets the site for the log provider.

Top

Methods

	Name	Description
	CloseLog	Closes the log.
	Dispose	Releases the resources used by the log provider.
	Equals	Determines whether two object instances are equal. (Inherited from DtsObject.)
	GetExecutionPath	Returns a String that contains the execution path of the log provider.
	GetExpression	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.
	GetType	(Inherited from Object.)
	LoadFromXML	This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
	OpenLog	Opens the log.
	SaveToXML	This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml 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.
	ToString	(Inherited from Object.)

Top

Events

	Name	Description
	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.

Share via