Share via


PackageClass Class

Definition

Represents a class for the Package interface.

public ref class PackageClass : Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSBreakpointSite100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSConfigurationControl100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSContainer100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSDumpConfiguration100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSEventsProvider100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSExecutionMetrics100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSName100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSPackageSigning100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSPersist100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSProjectPackage100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSPropertiesProvider100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSRuntimeObject100, Microsoft::SqlServer::Dts::Runtime::Wrapper::IDTSSequence100, Microsoft::SqlServer::Dts::Runtime::Wrapper::Package
[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)]
[System.Runtime.InteropServices.Guid("6FB1D19E-B035-424C-B74D-EEE266E4D322")]
[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FCanCreate)]
public class PackageClass : Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSBreakpointSite100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSConfigurationControl100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSContainer100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSDumpConfiguration100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSEventsProvider100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSExecutionMetrics100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSName100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSPackageSigning100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSPersist100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSProjectPackage100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSPropertiesProvider100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSRuntimeObject100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSSequence100, Microsoft.SqlServer.Dts.Runtime.Wrapper.Package
[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)]
[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FCanCreate)]
[System.Runtime.InteropServices.Guid("7B49F131-7EA3-4109-9E30-4ACCC4A00E25")]
public class PackageClass : Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSBreakpointSite100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSConfigurationControl100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSContainer100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSDumpConfiguration100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSEventsProvider100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSExecutionMetrics100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSName100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSPackageSigning100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSPersist100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSProjectPackage100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSPropertiesProvider100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSRuntimeObject100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSSequence100, Microsoft.SqlServer.Dts.Runtime.Wrapper.Package
[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)]
[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FCanCreate)]
[System.Runtime.InteropServices.Guid("6E8597AE-3486-4838-A8E0-F5C683618DF4")]
public class PackageClass : Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSBreakpointSite100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSConfigurationControl100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSContainer100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSDumpConfiguration100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSEventsProvider100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSExecutionMetrics100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSName100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSPackageSigning100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSPersist100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSProjectPackage100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSPropertiesProvider100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSRuntimeObject100, Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSSequence100, Microsoft.SqlServer.Dts.Runtime.Wrapper.Package
[<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)>]
[<System.Runtime.InteropServices.Guid("6FB1D19E-B035-424C-B74D-EEE266E4D322")>]
[<System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FCanCreate)>]
type PackageClass = class
    interface Package
    interface IDTSPackage100
    interface IDTSPackageSigning100
    interface IDTSContainer100
    interface IDTSExecutable100
    interface IDTSEventsProvider100
    interface IDTSExecutionMetrics100
    interface IDTSSequence100
    interface IDTSPropertiesProvider100
    interface IDTSName100
    interface IDTSBreakpointSite100
    interface IDTSSuspend100
    interface IDTSPersist100
    interface IDTSRuntimeObject100
    interface IDTSDumpConfiguration100
    interface IDTSConfigurationControl100
    interface IDTSProjectPackage100
[<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)>]
[<System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FCanCreate)>]
[<System.Runtime.InteropServices.Guid("7B49F131-7EA3-4109-9E30-4ACCC4A00E25")>]
type PackageClass = class
    interface Package
    interface IDTSPackage100
    interface IDTSPackageSigning100
    interface IDTSContainer100
    interface IDTSExecutable100
    interface IDTSEventsProvider100
    interface IDTSExecutionMetrics100
    interface IDTSSequence100
    interface IDTSPropertiesProvider100
    interface IDTSName100
    interface IDTSBreakpointSite100
    interface IDTSSuspend100
    interface IDTSPersist100
    interface IDTSRuntimeObject100
    interface IDTSDumpConfiguration100
    interface IDTSConfigurationControl100
    interface IDTSProjectPackage100
[<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.None)>]
[<System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FCanCreate)>]
[<System.Runtime.InteropServices.Guid("6E8597AE-3486-4838-A8E0-F5C683618DF4")>]
type PackageClass = class
    interface Package
    interface IDTSPackage100
    interface IDTSPackageSigning100
    interface IDTSContainer100
    interface IDTSExecutable100
    interface IDTSEventsProvider100
    interface IDTSExecutionMetrics100
    interface IDTSSequence100
    interface IDTSPropertiesProvider100
    interface IDTSName100
    interface IDTSBreakpointSite100
    interface IDTSSuspend100
    interface IDTSPersist100
    interface IDTSRuntimeObject100
    interface IDTSDumpConfiguration100
    interface IDTSConfigurationControl100
    interface IDTSProjectPackage100
Public Class PackageClass
Implements IDTSBreakpointSite100, IDTSConfigurationControl100, IDTSContainer100, IDTSDumpConfiguration100, IDTSEventsProvider100, IDTSExecutionMetrics100, IDTSName100, IDTSPackageSigning100, IDTSPersist100, IDTSProjectPackage100, IDTSPropertiesProvider100, IDTSRuntimeObject100, IDTSSequence100, Package
Inheritance
PackageClass
Attributes
Implements

Remarks

For more information, see Package.

Constructors

PackageClass()

Initializes a new instance of the PackageClass class.

Properties

CertificateContext

Gets or sets the context of the certificate associated with the package.

CertificateObject

Gets or sets the certificate object associated with 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.

Configurations

Gets the collection of configurations for the package.

Connections

Gets the collection of connection managers for the package.

CreationDate

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

CreationName

Gets the name used to create the PackageClass object.

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 value that indicates whether the package is in debug mode.

DelayValidation

Gets or sets a value that indicates whether package validation is delayed until the package runs.

Description

Gets or sets the description of the package.

DesignEvents

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

DesignTimeProperties

Gets or sets the design time properties of a package such as layout information.

Disable

Gets or sets a value that indicates whether the PackageClass object is disabled.

DisableEventHandlers

Gets or sets a value that indicates whether the event handlers on the package are disabled.

DumpDescriptor

Gets or sets the dump descriptor for the package.

DumpOnAnyError

Gets or sets a value that indicates whether a dump file should be generated when any error occurs during package execution.

EnableConfigurations

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

EnableDump

Gets or sets a value that indicates whether the dump file generation is enabled.

EncryptCheckpoints

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

Errors

Gets the collection of errors associated with the package.

EventHandlers

Gets a collection of event handler objects.

EventInfos

Gets the IDTSEventInfos100 collection that is associated with the package.

Executables

Gets the collection of executable objects contained within the package.

ExecutionDuration

Gets the amount of time that the package spent in execution, in milliseconds.

ExecutionResult

Gets a value that indicates the success or failure of the execution of the package.

ExecutionStatus

Gets the current status of the execution.

ExtendedProperties

Gets the IDTSExtendedProperties100 collection for the package.

FailPackageOnFailure

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

FailParentOnFailure

Gets or sets a value that indicates whether the parent package fails when a child package fails.

ForcedExecutionValue

If the ForceExecutionValue property is set to true, gets or sets a value that specifies the optional execution value that the package returns.

ForceExecutionResult

Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the package.

ForceExecutionValue

Gets or sets a value that indicates whether the execution value of the package should be forced to contain a particular value.

ID

Gets the ID of the package.

IDTSPackageSigning100_CertificateContext

Gets or sets the certificate context.

IDTSPackageSigning100_CertificateObject

Gets or sets the certificate object.

IDTSPackageSigning100_CheckSignatureOnLoad

Gets or sets a value that indicates whether the package checks the signature on loading.

IDTSSuspend100_SuspendRequired

Gets or sets a value that indicates whether the task should suspend when they encounter a breakpoint.

IgnoreConfigurationsOnLoad

Gets or sets a value that indicates whether the package ignores configurations when the package is loaded.

InteractiveMode

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

IsDefaultLocaleID

Gets a value that indicates whether the package uses the default locale.

IsolationLevel

Gets or sets the isolation level of the transaction in the package.

LastModifiedProductVersion

Gets the product version of the last modified package.

LocaleID

Gets or sets the identifier of the locale used by a package.

LogEntryInfos

Gets a collection of log entry definitions.

LoggingMode

Gets or sets the logging mode of the package.

LoggingOptions

Gets the filtering and logging resource for the package.

LogProviders

Gets 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 the maximum number of errors that can occur before the package stops running.

Name

Gets or sets the name of the PackageClass.

OfflineMode

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

PackageFormatVersion

Gets the format version of the package.

PackageLocation

Gets the location of the package.

PackagePassword

Sets the password for the package.

PackagePriorityClass

Gets or sets the Win32 thread priority class of the package thread.

PackageType

Gets or sets a value that identifies the tool that created the package.

PackageUpgradeOptions

Gets or sets the upgrade options for the package.

Parent

Gets the parent of the package.

PrecedenceConstraints

Gets a collection of precedence constraints for the package.

Properties

Gets a collection of properties for the package.

ProtectionLevel

Gets or sets the level of protection on the package.

SafeRecursiveProjectPackageExecution

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

SaveCheckpoints

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

SQLFolder

Gets or sets the SQL folder for the package.

StartTime

Gets the time when the package starts execution.

StopTime

Gets the time when the package stops execution.

SuppressConfigurationWarnings

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

SuspendRequired

Gets or sets a value that indicates whether the tasks should suspend when they encounter a breakpoint.

TransactionOption

Gets or sets a DTSTransactionOption enumeration value that indicates whether the package participates in transaction.

UpdateObjects

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

UpdatePackage

Gets or sets a value that indicates whether the packages can be updated when an updated version is found.

VariableDispenser

Gets the dispenser of the variables in the package.

Variables

Gets a collection that contains the variables associated with the package.

VersionBuild

Gets or sets the build version of the package.

VersionComments

Gets or sets the version comments associated with the package.

VersionGUID

Gets the version GUID generated when the package is first created.

VersionMajor

Gets or sets the major build version of the package.

VersionMinor

Gets or sets the minor build version of the package.

Warnings

Gets the collection of warnings set on the package.

Methods

AcceptBreakpointManager(IDTSBreakpointManager100)

Passes a breakpoint manager to a package.

CheckSignature()

Checks the status of the digital signature of the package.

ComputeExpressions(Boolean)

Computes the expression of this PackageClass object.

Execute()

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

Execute(IDTSConnections100, IDTSVariables100, IDTSEvents100, IDTSLogging100, Object)

Runs the application, container, or package as part of a package workflow.

ExportConfigurationFile(String)

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

FindReferencedObjects(Object)

Returns a reference object enumeration.

GetBreakpointTargets(IDTSBreakpointSite100, Boolean)

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

GetExpression(String)

Returns a value that contains the expression for the specified property.

GetObjectFromPackagePath(String, IDTSProperty100)

Returns an object from the specified package path.

GetParentID()

Retrieves the parent identifier of the package.

GetPreExecutionPackageXML(Object)

Retrieves the pre-execution of a package XML.

GetProject()

Retrieves the DTS project.

IDTSExecutable100_Execute(IDTSConnections100, IDTSVariables100, IDTSEvents100, IDTSLogging100, Object)

Executes the executable.

IDTSExecutable100_Validate(IDTSConnections100, IDTSVariables100, IDTSEvents100, IDTSLogging100)

Verifies that the executable will successfully execute by validating all its dependencies and other items before executing it.

IDTSPackageSigning100_CheckSignature()

Checks the signature of the package.

IDTSPackageSigning100_get_CertificateContext()
IDTSPackageSigning100_get_CertificateObject()
IDTSPackageSigning100_get_CheckSignatureOnLoad()
IDTSPackageSigning100_LoadUserCertificateByHash(Byte[])

Loads the user certificate using hash.

IDTSPackageSigning100_LoadUserCertificateByName(String)

Loads the user certificate by name.

IDTSPackageSigning100_set_CertificateContext(Int64)
IDTSPackageSigning100_set_CertificateObject(Object)
IDTSPackageSigning100_set_CheckSignatureOnLoad(Boolean)
IDTSSuspend100_get_SuspendRequired()
IDTSSuspend100_ResumeExecution()

Resumes the execution of the task after pausing.

IDTSSuspend100_set_SuspendRequired(Boolean)
IDTSSuspend100_SuspendExecution()

Notifies that the executable needs to suspend.

ImportConfigurationFile(String)

Loads a configuration file associated with the package.

LoadFromXML(Object, IDTSEvents100)

Loads a package and all its objects that have been saved to memory in XML format.

LoadUserCertificateByHash(Byte[])

Loads the user certificate using hash.

LoadUserCertificateByName(String)

Loads the user certificate by name.

PasswordMatch(String)

Determines whether the specified password matches with the package password.

PermitUnencryptedSave(Boolean)

Permits the unencrypted information to save.

ProcessConfiguration(String, Object)

Specifies the configuration information for a package and its objects.

RegenerateID()

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

ResumeExecution()

Resumes the execution of the package after pausing.

SaveToXML(Object, Object, IDTSEvents100)

Saves the package to memory in an XML format.

SetExpression(String, String)

Assigns the specified expression to the property.

SetProject(IDTSProject100, String)

Sets the specified project.

SuspendExecution()

Called when the executable needs to suspend. This method is called by the runtime engine.

Validate(IDTSConnections100, IDTSVariables100, IDTSEvents100, IDTSLogging100)

Allows the package to determine if it contains invalid settings that will prevent it from executing successfully.

Applies to