• Article

Package Members

Include Protected Members
Include Inherited Members

Represents the package container. This class cannot be inherited.

The Package type exposes the following members.

Constructors

  Name Description
Public method Package() Initializes a new instance of the Package class.

Top

Methods

  Name Description
Public method AcceptBreakpointManager(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.)
Public method CheckSignature() Checks the status of the digital signature of the package.
Public method Dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from DtsContainer.)
Public method Equals(Object) Determines whether two object instances are equal. (Inherited from DtsObject.)
Public method Execute() Returns a DTSExecResult enumeration that contains information about the success or failure of the package execution.
Public method Execute(Connections, Variables, IDTSEvents, IDTSLogging, Object) Runs the application, container, or package as part of a package workflow. (Inherited from DtsContainer.)
Public method ExportConfigurationFile(String) Creates an XML file that contains all deployable variables in the package.
Protected method Finalize() (Inherited from Object.)
Public method FindReferencedObjects(Object) Returns a reference object enumeration.
Public method GetBreakpointTargets(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.
Public method GetExpression(String) 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 GetObjectFromPackagePath(String, DtsProperty%) Returns a package property and the object from the specified package path.
Public method GetPackagePath() Returns a String that contains the relative path to the package location.
Public method GetType() (Inherited from Object.)
Public method ImportConfigurationFile(String) Loads a configuration file associated with the package.
Public method LoadFromXML(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.)
Public method LoadFromXML(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.
Public method LoadUserCertificateByHash(array<Byte[]) Loads the certificate for the package according to the certificate hash.
Public method LoadUserCertificateByName(String) Loads the certificate for the package according to the certificate name.
Protected method MemberwiseClone() (Inherited from Object.)
Public method ProcessConfiguration(String, Object) Sets configuration information for a package and its objects.
Public method RegenerateID() Creates a new GUID for the package and updates the package ID property.
Public method ResumeExecution() Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. (Inherited from DtsContainer.)
Public method SaveToXML(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.
Public method SaveToXML(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.)
Public method SetExpression(String, String) Assigns the specified expression to the property. Specify nulla null reference (Nothing in Visual Basic) to remove an existing expression from the property.
Protected method SetWrappedExecutable(IDTSExecutable100) Infrastructure. (Inherited from EventsProvider.)
Public method SuspendExecution() Called when the executable needs to suspend. This method is called by the runtime engine. (Inherited from DtsContainer.)
Public method ToString() (Inherited from Object.)
Public method Validate(Connections, Variables, IDTSEvents, IDTSLogging) Allows the container to determine if it contains invalid settings that will prevent it from executing successfully. (Inherited from DtsContainer.)

Top

Fields

  Name Description
Protected field m_executable Infrastructure. (Inherited from Executable.)

Top

Properties

  Name Description
Public property CertificateContext Gets or sets the certificate context.
Public property CertificateObject Gets or sets the X.509 certificate object for the package.
Public property CheckpointFileName Gets or sets the name of the file that captures the checkpoint information, which enables a package to restart.
Public property CheckpointUsage Gets or sets a value that specifies if or when a package is restarted.
Public property CheckSignatureOnLoad Gets or sets a value indicating whether the digital signature is checked when a package is loaded.
Public property Configurations Returns the collection of configurations for the package. A package can have more than one configuration associated with it. This property is read-only.
Public property Connections Returns the collection of connection managers for the package.
Public property CreationDate Gets or sets the date and time that the package was created.
Public property CreationName Returns the string that is used to create an instance of the DtsContainer object. This property is read-only. (Inherited from DtsContainer.)
Public property CreatorComputerName Gets or sets the name of the computer on which the package was created.
Public property CreatorName Gets or sets the name of the individual who created the package.
Public property DebugMode 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.)
Public property DelayValidation 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.)
Public property Description Gets or sets the description of the DtsContainer object. (Inherited from DtsContainer.)
Public property DesignEvents Gets or sets an IDTSEvents that indicates if the designer or other third-party client is to receive events during design time.
Public property Disable A Boolean that indicates if the DtsContainer object is disabled. (Inherited from DtsContainer.)
Public property DisableEventHandlers Gets or sets a Boolean that indicates whether the event handlers on task are disabled. (Inherited from EventsProvider.)
Public property EnableConfigurations Indicates whether the package loads configurations.
Public property EncryptCheckpoints Indicates if checkpoint files are encrypted.
Public property Errors Returns the collection of errors associated with the package. This field is read-only.
Public property EventHandlers Returns a collection of event handler objects. This field is read-only. (Inherited from EventsProvider.)
Public property EventInfos Returns a collection of EventInfo objects. This field is read-only. (Inherited from EventsProvider.)
Public property Executables Returns the collection of executable objects contained within the package that are a part of the package workflow.
Public property ExecutionDuration 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.)
Public property ExecutionResult Returns a value that indicates the success or failure of the execution of the DtsContainer object. (Inherited from DtsContainer.)
Public property ExecutionStatus Returns a value that indicates the current status of the execution of the DtsContainer object at the time of the call. (Inherited from DtsContainer.)
Public property ExtendedProperties Returns the ExtendedProperties collection for the package.
Public property FailPackageOnFailure
Public property FailParentOnFailure Gets or sets a Boolean that defines whether the parent container fails when a child container fails. (Inherited from DtsContainer.)
Public property ForcedExecutionValue 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.)
Public property ForceExecutionResult Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the container. (Inherited from DtsContainer.)
Public property ForceExecutionValue 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.)
Public property ID Returns the ID, which is a GUID, of the DtsContainer. The value is read-only. (Inherited from DtsContainer.)
Public property InteractiveMode Indicates if tasks should show user interface objects while executing.
Public property IsDefaultLocaleID A Boolean that indicates whether the container uses the default locale. This property is read-only. (Inherited from DtsContainer.)
Public property IsolationLevel Gets or sets the isolation level of the transaction in the DtsContainer object. (Inherited from DtsContainer.)
Public property LocaleID Gets or sets an Integer that indicates the Microsoft Win32® localeID to use when the DtsContainer object is executed. (Inherited from DtsContainer.)
Public property LogEntryInfos Returns a LogEntryInfos object. This property is read-only. (Inherited from DtsContainer.)
Public property LoggingMode Gets or sets a valid value from the DTSLoggingMode enumeration that indicates the logging mode of the container. (Inherited from DtsContainer.)
Public property LoggingOptions Returns an object that contains properties that indicates the filtering and logging resource for containers. This property is read-only. (Inherited from DtsContainer.)
Public property LogProviders Returns the collection of log providers associated with the package.
Public property MaxConcurrentExecutables Gets or sets the number of threads that a package can create.
Public property MaximumErrorCount 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.)
Public property Name Gets or sets the name of the DtsContainer. (Inherited from DtsContainer.)
Public property OfflineMode Gets or sets a Boolean that indicates if the package is working in offline mode.
Public property PackagePassword Sets the value of the password for the package. This property is write-only.
Public property PackagePriorityClass Specifies the Win32 thread priority class of the package thread.
Public property PackageType Sets or returns a value that identifies the tool that created the package.
Public property PackageUpgradeOptions
Public property Parent Returns the parent container. The value is read-only. (Inherited from DtsContainer.)
Public property PrecedenceConstraints Returns the collection of PrecedenceConstraint objects. This field is read-only.
Public property Properties Returns a collection of DtsProperties for the package.
Public property ProtectionLevel Gets or sets the level of protection on the package.
Public property SaveCheckpoints Gets or sets a value that determines if the package will use checkpoints during package execution.
Public property Site Infrastructure. (Inherited from DtsContainer.)
Public property StartTime Returns the time that the container began execution. This property is read-only. (Inherited from DtsContainer.)
Public property StopTime Returns the time that the container ended execution. This property is read-only. (Inherited from DtsContainer.)
Public property SuppressConfigurationWarnings Indicates if warnings generated by configurations are suppressed.
Public property SuspendRequired 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.)
Public property TransactionOption Gets or sets a DTSTransactionOption enumeration value that indicates whether the container participates in transactions. (Inherited from DtsContainer.)
Public property UpdateObjects *** Member deprecated; see Remarks. ***    Gets or sets a Boolean that indicates whether extensible objects can be updated at package load time if an updated version is found.
Public property VariableDispenser Returns a VariableDispenser object so variables associated with the container can be locked. (Inherited from DtsContainer.)
Public property Variables Returns a collection that contains the variables associated with this container. This property is read-only. (Inherited from DtsContainer.)
Public property VersionBuild Gets or sets the build version of the package.
Public property VersionComments Gets or sets the comments associated with the package.
Public property VersionGUID Returns a unique GUID generated when the package is first created. This field is read-only.
Public property VersionMajor Gets or sets the major build version of the package.
Public property VersionMinor Gets or sets the minor build version of the package.
Public property Warnings Returns a collection of warnings set on the package. This field is read-only.

Top

Events

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

Top