LogProvider Class
TOC
Collapse the table of content
Expand the table of content

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.

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

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

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

NameDescription
System_CAPS_pubpropertyConfigString

Gets or sets the connection and configuration information for the specific log provider.

System_CAPS_pubpropertyCreationName

Returns the string used by the runtime to create an instance of the LogProvider object. This property is read-only.

System_CAPS_pubpropertyDelayValidation

Gets or sets a Boolean that specifies whether a call to Validate for the log provider is delayed until package execution.

System_CAPS_pubpropertyDescription

Gets or sets the description of the LogProvider object.

System_CAPS_pubpropertyHasExpressions

Gets or sets a value that indicates whether the log provider has expressions.

System_CAPS_pubpropertyHostType

Gets an enumeration that describes the type of host that the log provider is being used by. This property is read-only

System_CAPS_pubpropertyID

Gets the ID of the LogProvider. This property is read-only.

System_CAPS_pubpropertyInnerObject

Returns the specific log provider that is being hosted by the LogProvider object.

System_CAPS_pubpropertyName

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.

System_CAPS_pubpropertyProperties

Returns a DtsProperties collection, which contains a collection of DtsProperty objects.

System_CAPS_pubpropertySite

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the site for the log provider.

NameDescription
System_CAPS_pubmethodCloseLog()

Closes the log.

System_CAPS_pubmethodDispose()

Releases the resources used by the log provider.

System_CAPS_pubmethodEquals(Object)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodGetExecutionPath()

Returns a String that contains the execution path of the log provider.

System_CAPS_pubmethodGetExpression(String)

Returns a String that contains the expression for the specified property. Null means no expression is assigned.

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetPackagePath()

Returns a String that contains the relative path to the package location.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodLoadFromXML(XmlNode, IDTSEvents)

This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.

System_CAPS_pubmethodOpenLog()

Opens the log.

System_CAPS_pubmethodSaveToXML(XmlDocument, XmlNode, IDTSEvents)

This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.

System_CAPS_pubmethodSetExpression(String, String)

Assigns the specified expression to the property. Specify null to remove an existing expression from the property.

System_CAPS_pubmethodToString()

(Inherited from Object.)

NameDescription
System_CAPS_pubeventDisposed

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

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.

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

Return to top
Show:
© 2016 Microsoft