Share via


Package Interface

This API supports the SQL Server 2012 infrastructure and is not intended to be used directly from your code.

For more information, see PackageClass.

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

Syntax

'Declaration
<GuidAttribute("BC427598-5FAD-4ECB-B6F4-30C3A147B16D")> _
Public Interface Package _
    Inherits IDTSPackage100
'Usage
Dim instance As Package
[GuidAttribute("BC427598-5FAD-4ECB-B6F4-30C3A147B16D")]
public interface Package : IDTSPackage100
[GuidAttribute(L"BC427598-5FAD-4ECB-B6F4-30C3A147B16D")]
public interface class Package : IDTSPackage100
[<GuidAttribute("BC427598-5FAD-4ECB-B6F4-30C3A147B16D")>]
type Package =  
    interface 
        interface IDTSPackage100 
    end
public interface Package extends IDTSPackage100

The Package type exposes the following members.

Properties

  Name Description
Public property CertificateContext Infrastructure. Gets or sets the certificate context. (Inherited from IDTSPackage100.)
Public property CertificateObject Infrastructure. Gets or sets the certificate package for the package. (Inherited from IDTSPackage100.)
Public property CheckpointFileName Infrastructure. Gets or sets the name of the file that captures the checkpoint information, which enables a package to restart. (Inherited from IDTSPackage100.)
Public property CheckpointUsage Infrastructure. Gets or sets a value that specifies if or when a package is restarted. (Inherited from IDTSPackage100.)
Public property CheckSignatureOnLoad Infrastructure. Gets or sets a value that indicates whether the digital signature is checked when a package is loaded from XML. (Inherited from IDTSPackage100.)
Public property Configurations Infrastructure. Gets the collection of configurations for the package. (Inherited from IDTSPackage100.)
Public property Connections Infrastructure. Gets the collection of connection managers for the package. (Inherited from IDTSPackage100.)
Public property CreationDate Infrastructure. Gets or sets the date and time that the package was created. (Inherited from IDTSPackage100.)
Public property CreatorComputerName Infrastructure. Gets or sets the name of the computer on which the package was created. (Inherited from IDTSPackage100.)
Public property CreatorName Infrastructure. Gets or sets the name of the individual who created the package. (Inherited from IDTSPackage100.)
Public property DesignEvents Infrastructure. Gets or sets the IDTSEvents100 that indicates if the designer or other third-party client is to receive events during design time. (Inherited from IDTSPackage100.)
Public property DesignTimeProperties Infrastructure. Gets or sets the design time properties of a package. (Inherited from IDTSPackage100.)
Public property EnableConfigurations Infrastructure. Gets or sets a value that indicates whether the package loads configurations. (Inherited from IDTSPackage100.)
Public property EncryptCheckpoints Infrastructure. Gets or sets a value that indicates whether checkpoint files are encrypted. (Inherited from IDTSPackage100.)
Public property Errors Infrastructure. Gets the collection of errors associated with the package. (Inherited from IDTSPackage100.)
Public property ExtendedProperties Infrastructure. Gets the IDTSExtendedProperties100 collection for the package. (Inherited from IDTSPackage100.)
Public property InteractiveMode Infrastructure. Gets or sets a value that indicates whether tasks should show user interface objects while executing. (Inherited from IDTSPackage100.)
Public property LastModifiedProductVersion Infrastructure. Gets the version of the package that is last modified. (Inherited from IDTSPackage100.)
Public property LogProviders Infrastructure. Returns the collection of log providers associated with the package. (Inherited from IDTSPackage100.)
Public property MaxConcurrentExecutables Infrastructure. Gets or sets the number of threads that a package can create. (Inherited from IDTSPackage100.)
Public property OfflineMode Infrastructure. Gets or sets a value that indicates whether the package is working in offline mode. (Inherited from IDTSPackage100.)
Public property PackageFormatVersion Infrastructure. Gets the format version of the package. (Inherited from IDTSPackage100.)
Public property PackageLocation Infrastructure. Gets or sets a string that contains the location of the package. (Inherited from IDTSPackage100.)
Public property PackagePassword Infrastructure. Sets the password for the package. (Inherited from IDTSPackage100.)
Public property PackagePriorityClass Infrastructure. Gets or sets the priority class of the package. (Inherited from IDTSPackage100.)
Public property PackageType Infrastructure. Gets or sets the package type. (Inherited from IDTSPackage100.)
Public property PackageUpgradeOptions Infrastructure. Gets or sets the package upgrade options. (Inherited from IDTSPackage100.)
Public property ProtectionLevel Infrastructure. Gets or sets the level of protection on the package. (Inherited from IDTSPackage100.)
Public property SafeRecursiveProjectPackageExecution Infrastructure. Gets or sets a value that indicates whether the package execution is a safe recursive project. (Inherited from IDTSPackage100.)
Public property SaveCheckpoints Infrastructure. Gets or sets a value that indicates whether the package will use checkpoints during package execution. (Inherited from IDTSPackage100.)
Public property SQLFolder Infrastructure. Gets or sets the package folder name. (Inherited from IDTSPackage100.)
Public property SuppressConfigurationWarnings Infrastructure. Gets or sets a value that indicates whether the warnings generated by configurations are suppressed. (Inherited from IDTSPackage100.)
Public property UpdateObjects Infrastructure. Gets or sets a value that indicates whether extensible objects can be updated at package load time if an updated version if found. (Inherited from IDTSPackage100.)
Public property UpdatePackage Infrastructure. Gets or sets a value that indicates whether packages can be updated when an updated version is found. (Inherited from IDTSPackage100.)
Public property VersionBuild Infrastructure. Gets or sets the build version of the package. (Inherited from IDTSPackage100.)
Public property VersionComments Infrastructure. Gets or sets the comments associated with the package. (Inherited from IDTSPackage100.)
Public property VersionGUID Infrastructure. Gets a unique GUID generated when the package is first created. (Inherited from IDTSPackage100.)
Public property VersionMajor Infrastructure. Gets or sets the major build version of the package. (Inherited from IDTSPackage100.)
Public property VersionMinor Infrastructure. Gets or sets the minor build version of the package. (Inherited from IDTSPackage100.)
Public property Warnings Infrastructure. Gets a collection of warnings set on the package. (Inherited from IDTSPackage100.)

Top

Methods

  Name Description
Public method CheckSignature Infrastructure. Checks the status of the digital signature of the package. (Inherited from IDTSPackage100.)
Public method Execute() Infrastructure. Returns a DTSExecResult enumeration that contains information about the success or failure of the package execution. (Inherited from IDTSPackage100.)
Public method Execute(IDTSConnections100, IDTSVariables100, IDTSEvents100, IDTSLogging100, Object) Infrastructure. Runs the application, container, or package as part of a package workflow. (Inherited from IDTSPackage100.)
Public method ExportConfigurationFile Infrastructure. Creates an XML file that contains all deployable variables in the package. (Inherited from IDTSPackage100.)
Public method FindReferencedObjects Infrastructure. Returns a reference object enumeration. (Inherited from IDTSPackage100.)
Public method GetBreakpointTargets Infrastructure. Returns IDTSBreakpointTargets100 collection. (Inherited from IDTSPackage100.)
Public method GetObjectFromPackagePath Infrastructure. Returns a package property and the object from the specified package path. (Inherited from IDTSPackage100.)
Public method GetPreExecutionPackageXML Infrastructure. Gets a pre-execution package XML. (Inherited from IDTSPackage100.)
Public method ImportConfigurationFile Infrastructure. Loads a configuration file associated with the package. (Inherited from IDTSPackage100.)
Public method LoadUserCertificateByHash Infrastructure. Loads the certificate for the package according to the certificate hash. (Inherited from IDTSPackage100.)
Public method LoadUserCertificateByName Infrastructure. Loads the certificate for the package according to the certificate name. (Inherited from IDTSPackage100.)
Public method PermitUnencryptedSave Infrastructure. Specifies the unencrypted permit. (Inherited from IDTSPackage100.)
Public method ProcessConfiguration Infrastructure. Sets configuration information for a package and its objects. (Inherited from IDTSPackage100.)
Public method Validate Infrastructure. Allows the container to determine if it contains invalid settings that will prevent it from executing successfully. (Inherited from IDTSPackage100.)

Top

See Also

Reference

Microsoft.SqlServer.Dts.Runtime.Wrapper Namespace