Package Members

Artykuł
12/03/2008

Represents the package container. This class cannot be inherited.

The following tables list the members exposed by the Package type.

Public Constructors

	Name	Description
	Package	Initializes a new instance of the Package class.

Top

Protected Fields

	Name	Description
	m_executable	(inherited from Executable )

Top

Public Properties

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

Top

Public Methods

(see also Protected Methods )

	Name	Description
	AcceptBreakpointManager	(inherited from DtsContainer )
	CheckSignature	Returns a DTSSignatureStatus enumeration that shows if the package has been flagged to have a digital signature. If so, the enumeration indicates the signature validity.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (inherited from DtsContainer)
	Equals	Overloaded. (inherited from DtsObject )
	Execute	Overloaded. Returns a DTSExecResult enumeration that contains information about the success or failure of the package execution.
	ExportConfigurationFile	Creates an XML file that contains all deployable variables in the package.
	FindReferencedObjects	Returns a reference object enumeration.
	GetBreakpointTargets	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.
	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)
	GetObjectFromPackagePath	Returns a package property and the object from the specified package path.
	GetPackagePath	Returns a String that contains the relative path to the package location.
	GetType	(inherited from Object )
	ImportConfigurationFile	Loads a configuration file associated with the package.
	LoadFromXML	Overloaded. Loads a package and all its objects that have been saved in memory in XML format. Use the Application class to load packages that have been saved to the file system.
	LoadUserCertificateByHash	Loads the certificate for the package according to the certificate hash.
	LoadUserCertificateByName	Loads the certificate for the package according to the certificate name.
	op_Equality	(inherited from DtsObject )
	op_Inequality	(inherited from DtsObject )
	ProcessConfiguration	This method allows you to set configuration information for a package and its objects.
	ReferenceEquals	(inherited from Object )
	RegenerateID	Creates a new GUID for the package and updates the package ID property.
	ResumeExecution	Resumes execution of the task after pausing. The task or container is resumed by the runtime engine. (inherited from DtsContainer)
	SaveToXML	Overloaded. Saves the package in an XML format.
	SetExpression	Assigns the specified expression to the property. Specify null to remove an existing expression from the property.
	SuspendExecution	Called when the executable needs to suspend. This method is called by the runtime engine. (inherited from DtsContainer)
	ToString	(inherited from Object )
	Validate	(inherited from DtsContainer )