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

Package Class

 

Represents the package container. This class cannot be inherited.

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


public sealed class Package : EventsProvider, IDTSSequence, IDTSPropertiesProvider, 
	IDTSPropertiesProviderEx, IDTSPackagePath, IDTSExecutionPath, 
	IDTSConfigurationControl

NameDescription
System_CAPS_pubmethodPackage()

Initializes a new instance of the Package class.

NameDescription
System_CAPS_pubpropertyCertificateContext

Gets or sets the certificate context.

System_CAPS_pubpropertyCertificateObject

Gets or sets the X.509 certificate object for the package.

System_CAPS_pubpropertyCheckpointFileName

Gets or sets the name of the file that captures the checkpoint information, which enables a package to restart.

System_CAPS_pubpropertyCheckpointUsage

Gets or sets a value that specifies if or when a package is restarted.

System_CAPS_pubpropertyCheckSignatureOnLoad

Gets or sets a value indicating whether the digital signature is checked when a package is loaded.

System_CAPS_pubpropertyConfigurations

Gets the collection of configurations for the package. A package can have more than one configuration associated with it. This property is read-only.

System_CAPS_pubpropertyConnections

Gets the collection of connection managers for the package.

System_CAPS_pubpropertyCreationDate

Gets or sets the date and time that the package was created.

System_CAPS_pubpropertyCreationName

Returns the string that is used to create an instance of the DtsContainer object. This property is read-only.(Inherited from DtsContainer.)

System_CAPS_pubpropertyCreatorComputerName

Gets or sets the name of the computer on which the package was created.

System_CAPS_pubpropertyCreatorName

Gets or sets the name of the individual who created the package.

System_CAPS_pubpropertyDebugMode

Gets or sets a Boolean that indicates whether the DtsContainer object is in debug mode and whether it should fire the OnBreakpointHit event while running. (Inherited from DtsContainer.)

System_CAPS_pubpropertyDelayValidation

Gets or sets a Boolean that indicates whether validation of the task is delayed until run time. The default value is false.(Inherited from DtsContainer.)

System_CAPS_pubpropertyDescription

Gets or sets the description of the DtsContainer object.(Inherited from DtsContainer.)

System_CAPS_pubpropertyDesignEvents

Gets or sets an IDTSEvents that indicates if the designer or other third-party client is to receive events during design time.

System_CAPS_pubpropertyDesignTimeProperties

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the design time properties of a package such as layout information.

System_CAPS_pubpropertyDisable

A Boolean that indicates if the DtsContainer object is disabled. (Inherited from DtsContainer.)

System_CAPS_pubpropertyDisableEventHandlers

Gets or sets a Boolean that indicates whether the event handlers on task are disabled. (Inherited from EventsProvider.)

System_CAPS_pubpropertyDumpDescriptor

This API supports the product infrastructure and is not intended to be used directly from your code. Specify when a dump file should be generated.

System_CAPS_pubpropertyDumpOnAnyError

This API supports the product infrastructure and is not intended to be used directly from your code. Specify if a dump file should be generated when any error occurs during package execution.

System_CAPS_pubpropertyEnableConfigurations

Gets or sets a value that indicates whether the package loads configurations.

System_CAPS_pubpropertyEnableDump

This API supports the product infrastructure and is not intended to be used directly from your code. Specify if the dump file generation is enabled.

System_CAPS_pubpropertyEncryptCheckpoints

Gets or sets a value that indicates whether the checkpoint files are encrypted.

System_CAPS_pubpropertyErrors

Gets the collection of errors associated with the package. This field is read-only.

System_CAPS_pubpropertyEventHandlers

Returns a collection of event handler objects. This field is read-only.(Inherited from EventsProvider.)

System_CAPS_pubpropertyEventInfos

Returns a collection of EventInfo objects. This field is read-only.(Inherited from EventsProvider.)

System_CAPS_pubpropertyExecutables

Gets the collection of executable objects contained within the package that are a part of the package workflow.

System_CAPS_pubpropertyExecutionDuration

Returns a value that indicates the amount of time that the container spent in execution, in milliseconds. This property is read-only. (Inherited from DtsContainer.)

System_CAPS_pubpropertyExecutionResult

Returns a value that indicates the success or failure of the execution of the DtsContainer object. (Inherited from DtsContainer.)

System_CAPS_pubpropertyExecutionStatus

Returns a value that indicates the current status of the execution of the DtsContainer object at the time of the call.(Inherited from DtsContainer.)

System_CAPS_pubpropertyExtendedProperties

Gets the ExtendedProperties collection for the package.

System_CAPS_pubpropertyFailPackageOnFailure

Gets or sets a value that indicates whether the package fails when a task or component in the package fails.

System_CAPS_pubpropertyFailParentOnFailure

Gets or sets a Boolean that defines whether the parent container fails when a child container fails.(Inherited from DtsContainer.)

System_CAPS_pubpropertyForcedExecutionValue

If the ForceExecutionValue property is set to True, gets or sets a value that specifies the optional execution value that the package returns.(Inherited from DtsContainer.)

System_CAPS_pubpropertyForceExecutionResult

Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container. (Inherited from DtsContainer.)

System_CAPS_pubpropertyForceExecutionValue

Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain a particular value.(Inherited from DtsContainer.)

System_CAPS_pubpropertyHasExpressions

Gets a value that indicates whether the package has expressions.

System_CAPS_pubpropertyID

Returns the ID, which is a GUID, of the DtsContainer. The value is read-only.(Inherited from DtsContainer.)

System_CAPS_pubpropertyIgnoreConfigurationsOnLoad

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the package ignores configurations when the package is loaded.

System_CAPS_pubpropertyInteractiveMode

Gets or sets a value that indicates whether the tasks should show user interface objects while executing.

System_CAPS_pubpropertyIsDefaultLocaleID

A Boolean that indicates whether the container uses the default locale. This property is read-only.(Inherited from DtsContainer.)

System_CAPS_pubpropertyIsolationLevel

Gets or sets the isolation level of the transaction in the DtsContainer object. (Inherited from DtsContainer.)

System_CAPS_pubpropertyLocaleID

Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the DtsContainer object is executed. (Inherited from DtsContainer.)

System_CAPS_pubpropertyLogEntryInfos

Returns a LogEntryInfos object. This property is read-only.(Inherited from DtsContainer.)

System_CAPS_pubpropertyLoggingMode

Gets or sets a valid value from the DTSLoggingMode enumeration that indicates the logging mode of the container.(Inherited from DtsContainer.)

System_CAPS_pubpropertyLoggingOptions

Returns an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only.(Inherited from DtsContainer.)

System_CAPS_pubpropertyLogProviders

Gets the collection of log providers associated with the package.

System_CAPS_pubpropertyMaxConcurrentExecutables

Gets or sets the number of threads that a package can create.

System_CAPS_pubpropertyMaximumErrorCount

Gets or sets an Integer value that indicates the maximum number of errors that can occur before the DtsContainer object stops running.(Inherited from DtsContainer.)

System_CAPS_pubpropertyName

Gets or sets the name of the DtsContainer.(Inherited from DtsContainer.)

System_CAPS_pubpropertyOfflineMode

Gets or sets a value that indicates whether the package is working in offline mode.

System_CAPS_pubpropertyPackagePassword

Sets the value of the password for the package. This property is write-only.

System_CAPS_pubpropertyPackagePriorityClass

Specifies the Win32 thread priority class of the package thread.

System_CAPS_pubpropertyPackageType

Specifies a value that identifies the tool that created the package.

System_CAPS_pubpropertyPackageUpgradeOptions

Gets or sets the upgrade options for the package.

System_CAPS_pubpropertyParameters

Gets the parameters collection for the package.

System_CAPS_pubpropertyParent

Returns the parent container. The value is read-only.(Inherited from DtsContainer.)

System_CAPS_pubpropertyPrecedenceConstraints

Gets the collection of the PrecedenceConstraint objects. This field is read-only.

System_CAPS_pubpropertyProject

Gets or sets the specified project associated with the package.

System_CAPS_pubpropertyProperties

Gets the collection of the DtsProperties object for the package.

System_CAPS_pubpropertyProtectionLevel

Gets the level of protection on the package.

System_CAPS_pubpropertySafeRecursiveProjectPackageExecution

Gets or sets a value that indicates whether recursive execution of the package is safe.

System_CAPS_pubpropertySaveCheckpoints

Gets or sets a value that indicates whether the package will use checkpoints during package execution.

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 container.(Inherited from DtsContainer.)

System_CAPS_pubpropertyStartTime

Returns the time that the container began execution. This property is read-only. (Inherited from DtsContainer.)

System_CAPS_pubpropertyStopTime

Returns the time that the container ended execution. This property is read-only.(Inherited from DtsContainer.)

System_CAPS_pubpropertySuppressConfigurationWarnings

Gets or sets a value that indicates whether the warnings generated by configurations are suppressed.

System_CAPS_pubpropertySuspendRequired

Gets or sets a Boolean that indicates if tasks should suspend when they encounter a breakpoint. This value is set by the runtime engine for tasks and containers when a breakpoint is encountered.(Inherited from DtsContainer.)

System_CAPS_pubpropertyTransactionOption

Gets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions.(Inherited from DtsContainer.)

System_CAPS_pubpropertyUpdateObjects

*** Member deprecated; see Remarks. ***   Gets or sets a value that indicates whether the extensible objects can be updated at package load time if an updated version is found.

System_CAPS_pubpropertyVariableDispenser

Returns a VariableDispenser object so variables associated with the container can be locked. (Inherited from DtsContainer.)

System_CAPS_pubpropertyVariables

Returns a collection that contains the variables associated with this container. This property is read-only.(Inherited from DtsContainer.)

System_CAPS_pubpropertyVersionBuild

Gets the build version of the package.

System_CAPS_pubpropertyVersionComments

Gets the version comments associated with the package.

System_CAPS_pubpropertyVersionGUID

Gets the version GUID generated when the package is first created. This field is read-only.

System_CAPS_pubpropertyVersionMajor

Gets the major build version of the package.

System_CAPS_pubpropertyVersionMinor

Gets the minor build version of the package.

System_CAPS_pubpropertyWarnings

Gets the collection of warnings set on the package. This field is read-only.

NameDescription
System_CAPS_pubmethodAcceptBreakpointManager(BreakpointManager)

This method is called by the run-time engine when a task or container is created, and passes it a BreakpointManager manager to allow the task to create, remove, and check the status of breakpoints. This method is called by the runtime and is not used in code.(Inherited from DtsContainer.)

System_CAPS_pubmethodAddDataTapPoint(String, String, Int32, String)

Add a data tap point on a given data flow path of the given data flow task.

System_CAPS_pubmethodCheckSignature()

Checks the status of the digital signature of the package.

System_CAPS_pubmethodComputeExpressions(Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. Compute expressions of the package object.

System_CAPS_pubmethodDispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.(Inherited from DtsContainer.)

System_CAPS_pubmethodEquals(Object)

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

System_CAPS_pubmethodExecute()

Returns a DTSExecResult enumeration that contains information about the success or failure of the package execution.

System_CAPS_pubmethodExecute(Connections, Variables, IDTSEvents, IDTSLogging, Object)

Runs the application, container, or package as part of a package workflow.(Inherited from DtsContainer.)

System_CAPS_pubmethodExportConfigurationFile(String)

Creates an XML file that contains all deployable variables in the package.

System_CAPS_pubmethodFindReferencedObjects(Object)

Returns a reference object enumeration.

System_CAPS_pubmethodGetBreakpointTargets(IDTSBreakpointSite, Boolean)

Returns a BreakpointTargets collection. Depending on the setting of the onlyEnabled parameter, the collection contains all breakpoint targets in the package, or only enabled breakpoint targets.

System_CAPS_pubmethodGetExecutionPath()

Returns the execution path of the current package.

System_CAPS_pubmethodGetExpression(String)

Returns a value 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_pubmethodGetObjectFromPackagePath(String, DtsProperty)

Returns a package property and the object from the specified package path.

System_CAPS_pubmethodGetPackagePath()

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

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodImportConfigurationFile(String)

Loads a configuration file associated with the package.

System_CAPS_pubmethodLoadFromXML(String, IDTSEvents)

Loads a package and all its objects that have been saved to memory in XML format. To load a package that is saved to the hard drive, use the Application.LoadPackage method.

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.(Inherited from DtsContainer.)

System_CAPS_pubmethodLoadUserCertificateByHash(Byte[])

Loads the certificate for the package according to the certificate hash.

System_CAPS_pubmethodLoadUserCertificateByName(String)

Loads the certificate for the package according to the certificate name.

System_CAPS_pubmethodProcessConfiguration(String, Object)

Specifies the configuration information for a package and its objects.

System_CAPS_pubmethodRegenerateID()

Creates a new GUID for the package and updates the package ID property.

System_CAPS_pubmethodResumeExecution()

Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. (Inherited from DtsContainer.)

System_CAPS_pubmethodSaveToXML(String, IDTSEvents)

Saves the package to memory in an XML format. To save a package as .xml to the hard drive, use the Application.SaveToXml method.

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.(Inherited from DtsContainer.)

System_CAPS_pubmethodSetExpression(String, String)

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

System_CAPS_pubmethodSuspendExecution()

Called when the executable needs to suspend. This method is called by the runtime engine. (Inherited from DtsContainer.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodValidate(Connections, Variables, IDTSEvents, IDTSLogging)

Allows the container to determine if it contains invalid settings that will prevent it from executing successfully.(Inherited from DtsContainer.)

NameDescription
System_CAPS_protfieldm_executable

This API supports the product infrastructure and is not intended to be used directly from your code. The executable.(Inherited from Executable.)

NameDescription
System_CAPS_pubeventDisposed

Adds an event handler to listen to the Disposed event on the component.(Inherited from DtsContainer.)

The package is a collection of other containers, connections, tasks, transformations, variables, configurations, and precedence constraints. Packages can be created programmatically, or by using the SSIS Designer graphical tool. Packages can be saved to various locations, including Microsoft SQL Server or an XML file.

For more information about packages, see Integration Services (SSIS) Packages.

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