Share via

PackageClass Class

  • Article

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

Represents a class for the Package interface.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.Wrapper.PackageClass

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

Syntax

'Declaration
<ClassInterfaceAttribute(ClassInterfaceType.None)> _
<GuidAttribute("4555B0A5-E8D7-49BD-B299-3140C34D3769")> _
Public Class PackageClass _
    Implements Package, IDTSPackage100, IDTSPackageSigning100, IDTSContainer100,  _
    IDTSExecutable100, IDTSEventsProvider100, IDTSExecutionMetrics100, IDTSSequence100, IDTSPropertiesProvider100,  _
    IDTSName100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100,  _
    IDTSDumpConfiguration100, IDTSConfigurationControl100, IDTSProjectPackage100
'Usage
Dim instance As PackageClass

[ClassInterfaceAttribute(ClassInterfaceType.None)]
[GuidAttribute("4555B0A5-E8D7-49BD-B299-3140C34D3769")]
public class PackageClass : Package, 
    IDTSPackage100, IDTSPackageSigning100, IDTSContainer100, IDTSExecutable100, IDTSEventsProvider100, 
    IDTSExecutionMetrics100, IDTSSequence100, IDTSPropertiesProvider100, IDTSName100, IDTSBreakpointSite100, 
    IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100, IDTSDumpConfiguration100, IDTSConfigurationControl100, 
    IDTSProjectPackage100

[ClassInterfaceAttribute(ClassInterfaceType::None)]
[GuidAttribute(L"4555B0A5-E8D7-49BD-B299-3140C34D3769")]
public ref class PackageClass : Package, 
    IDTSPackage100, IDTSPackageSigning100, IDTSContainer100, IDTSExecutable100, IDTSEventsProvider100, 
    IDTSExecutionMetrics100, IDTSSequence100, IDTSPropertiesProvider100, IDTSName100, IDTSBreakpointSite100, 
    IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100, IDTSDumpConfiguration100, IDTSConfigurationControl100, 
    IDTSProjectPackage100

[<ClassInterfaceAttribute(ClassInterfaceType.None)>]
[<GuidAttribute("4555B0A5-E8D7-49BD-B299-3140C34D3769")>]
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 
    end

public class PackageClass implements Package, IDTSPackage100, IDTSPackageSigning100, IDTSContainer100, IDTSExecutable100, IDTSEventsProvider100, IDTSExecutionMetrics100, IDTSSequence100, IDTSPropertiesProvider100, IDTSName100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100, IDTSDumpConfiguration100, IDTSConfigurationControl100, IDTSProjectPackage100

The PackageClass type exposes the following members.

Constructors

  Name Description
Public method PackageClass Infrastructure. Initializes a new instance of the PackageClass class.

Top

Properties

  Name Description
Public property CertificateContext Infrastructure. Gets or sets the context of the certificate associated with the package.
Public property CertificateObject Infrastructure. Gets or sets the certificate object associated with the package.
Public property CheckpointFileName Infrastructure. Gets or sets the name of the file that captures the checkpoint information, which enables a package to restart.
Public property CheckpointUsage Infrastructure. Gets or sets a value that specifies if or when a package is restarted.
Public property CheckSignatureOnLoad Infrastructure. Gets or sets a value that indicates whether the digital signature is checked when a package is loaded.
Public property Configurations Infrastructure. Gets the collection of configurations for the package.
Public property Connections Infrastructure. Gets the collection of connection managers for the package.
Public property CreationDate Infrastructure. Gets or sets the date and time that the package was created.
Public property CreationName Infrastructure. Gets the name used to create the PackageClass object.
Public property CreatorComputerName Infrastructure. Gets or sets the name of the computer on which the package was created.
Public property CreatorName Infrastructure. Gets or sets the name of the individual who created the package.
Public property DebugMode Infrastructure. Gets or sets a value that indicates whether the package is in debug mode.
Public property DelayValidation Infrastructure. Gets or sets a value that indicates whether package validation is delayed until the package runs.
Public property Description Infrastructure. Gets or sets the description of the package.
Public property DesignEvents Infrastructure. Gets or sets an IDTSEvents100 that indicates if the designer or other third party client is to receive events during design time.
Public property DesignTimeProperties Infrastructure. Gets or sets the design time properties of a package such as layout information.
Public property Disable Infrastructure. Gets or sets a value that indicates whether the PackageClass object is disabled.
Public property DisableEventHandlers Infrastructure. Gets or sets a value that indicates whether the event handlers on the package are disabled.
Public property DumpDescriptor Infrastructure. Gets or sets the dump descriptor for the package.
Public property DumpOnAnyError Infrastructure. Gets or sets a value that indicates whether a dump file should be generated when any error occurs during package execution.
Public property EnableConfigurations Infrastructure. Gets or sets a value that indicates whether the package loads configurations.
Public property EnableDump Infrastructure. Gets or sets a value that indicates whether the dump file generation is enabled.
Public property EncryptCheckpoints Infrastructure. Gets or sets a value that indicates whether the checkpoint files are encrypted.
Public property Errors Infrastructure. Gets the collection of errors associated with the package.
Public property EventHandlers Infrastructure. Gets a collection of event handler objects.
Public property EventInfos Infrastructure. Gets the IDTSEventInfos100 collection that is associated with the package.
Public property Executables Infrastructure. Gets the collection of executable objects contained within the package.
Public property ExecutionDuration Infrastructure. Gets the amount of time that the package spent in execution, in milliseconds.
Public property ExecutionResult Infrastructure. Gets a value that indicates the success or failure of the execution of the package.
Public property ExecutionStatus Infrastructure. Gets the current status of the execution.
Public property ExtendedProperties Infrastructure. Gets the IDTSExtendedProperties100 collection for the package.
Public property FailPackageOnFailure Infrastructure. Gets or sets a value that indicates whether the package fails when a task or component in the package fails.
Public property FailParentOnFailure Infrastructure. Gets or sets a value that indicates whether the parent package fails when a child package fails.
Public property ForcedExecutionValue Infrastructure. If the ForceExecutionValue property is set to true, gets or sets a value that specifies the optional execution value that the package returns.
Public property ForceExecutionResult Infrastructure. Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the package.
Public property ForceExecutionValue Infrastructure. Gets or sets a value that indicates whether the execution value of the package should be forced to contain a particular value.
Public property ID Infrastructure. Gets the ID of the package.
Public property IDTSPackageSigning100_CertificateContext Infrastructure. Gets or sets the certificate context.
Public property IDTSPackageSigning100_CertificateObject Infrastructure. Gets or sets the certificate object.
Public property IDTSPackageSigning100_CheckSignatureOnLoad Infrastructure. Gets or sets a value that indicates whether the package checks the signature on loading.
Public property IDTSSuspend100_SuspendRequired Infrastructure. Gets or sets a value that indicates whether the task should suspend when they encounter a breakpoint.
Public property IgnoreConfigurationsOnLoad Infrastructure. Gets or sets a value that indicates whether the package ignores configurations when the package is loaded.
Public property InteractiveMode Infrastructure. Gets or sets a value that indicates whether the tasks should show user interface objects while executing.
Public property IsDefaultLocaleID Infrastructure. Gets a value that indicates whether the package uses the default locale.
Public property IsolationLevel Infrastructure. Gets or sets the isolation level of the transaction in the package.
Public property LastModifiedProductVersion Infrastructure. Gets the product version of the last modified package.
Public property LocaleID Infrastructure. Gets or sets the identifier of the locale used by a package.
Public property LogEntryInfos Infrastructure. Gets a collection of log entry definitions.
Public property LoggingMode Infrastructure. Gets or sets the logging mode of the package.
Public property LoggingOptions Infrastructure. Gets the filtering and logging resource for the package.
Public property LogProviders Infrastructure. Gets the collection of log providers associated with the package.
Public property MaxConcurrentExecutables Infrastructure. Gets or sets the number of threads that a package can create.
Public property MaximumErrorCount Infrastructure. Gets or sets the maximum number of errors that can occur before the package stops running.
Public property Name Infrastructure. Gets or sets the name of the PackageClass.
Public property OfflineMode Infrastructure. Gets or sets a value that indicates whether the package is working in offline mode.
Public property PackageFormatVersion Infrastructure. Gets the format version of the package.
Public property PackageLocation Infrastructure. Gets the location of the package.
Public property PackagePassword Infrastructure. Sets the password for the package.
Public property PackagePriorityClass Infrastructure. Gets or sets the Win32 thread priority class of the package thread.
Public property PackageType Infrastructure. Gets or sets a value that identifies the tool that created the package.
Public property PackageUpgradeOptions Infrastructure. Gets or sets the upgrade options for the package.
Public property Parent Infrastructure. Gets the parent of the package.
Public property PrecedenceConstraints Infrastructure. Gets a collection of precedence constraints for the package.
Public property Properties Infrastructure. Gets a collection of properties for the package.
Public property ProtectionLevel Infrastructure. Gets or sets the level of protection on the package.
Public property SafeRecursiveProjectPackageExecution Infrastructure. Gets or sets a value that indicates whether recursive execution of the package is safe.
Public property SaveCheckpoints Infrastructure. Gets or sets a value that indicates whether the package will use checkpoints during package execution.
Public property SQLFolder Infrastructure. Gets or sets the SQL folder for the package.
Public property StartTime Infrastructure. Gets the time when the package starts execution.
Public property StopTime Infrastructure. Gets the time when the package stops execution.
Public property SuppressConfigurationWarnings Infrastructure. Gets or sets a value that indicates whether the warnings generated by configurations are suppressed.
Public property SuspendRequired Infrastructure. Gets or sets a value that indicates whether the tasks should suspend when they encounter a breakpoint.
Public property TransactionOption Infrastructure. Gets or sets a DTSTransactionOption enumeration value that indicates whether the package participates in transaction.
Public property UpdateObjects Infrastructure. Gets or sets a value that indicates whether the extensible objects can be updated at package load time if an updated version is found.
Public property UpdatePackage Infrastructure. Gets or sets a value that indicates whether the packages can be updated when an updated version is found.
Public property VariableDispenser Infrastructure. Gets the dispenser of the variables in the package.
Public property Variables Infrastructure. Gets a collection that contains the variables associated with the package.
Public property VersionBuild Infrastructure. Gets or sets the build version of the package.
Public property VersionComments Infrastructure. Gets or sets the version comments associated with the package.
Public property VersionGUID Infrastructure. Gets the version GUID generated when the package is first created.
Public property VersionMajor Infrastructure. Gets or sets the major build version of the package.
Public property VersionMinor Infrastructure. Gets or sets the minor build version of the package.
Public property Warnings Infrastructure. Gets the collection of warnings set on the package.

Top

Methods

  Name Description
Public method AcceptBreakpointManager Infrastructure. Passes a breakpoint manager to a package.
Public method CheckSignature Infrastructure. Checks the status of the digital signature of the package.
Public method ComputeExpressions Infrastructure. Computes the expression of this PackageClass object.
Public method Equals (Inherited from Object.)
Public method Execute() Infrastructure. Returns a DTSExecResult enumeration that contains information about the success or failure of the package execution.
Public method Execute(IDTSConnections100, IDTSVariables100, IDTSEvents100, IDTSLogging100, Object) Infrastructure. Runs the application, container, or package as part of a package workflow.
Public method ExportConfigurationFile Infrastructure. Creates an XML file that contains all deployable variables in the package.
Protected method Finalize (Inherited from Object.)
Public method FindReferencedObjects Infrastructure. Returns a reference object enumeration.
Public method GetBreakpointTargets Infrastructure. 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.
Public method GetExpression Infrastructure. Returns a value that contains the expression for the specified property.
Public method GetHashCode (Inherited from Object.)
Public method GetObjectFromPackagePath Infrastructure. Returns an object from the specified package path.
Public method GetParentID Infrastructure. Retrieves the parent identifier of the package.
Public method GetPreExecutionPackageXML Infrastructure. Retrieves the pre-execution of a package XML.
Public method GetProject Infrastructure. Retrieves the DTS project.
Public method GetType (Inherited from Object.)
Public method IDTSExecutable100_Execute Infrastructure. Executes the executable.
Public method IDTSExecutable100_Validate Infrastructure. Verifies that the executable will successfully execute by validating all its dependencies and other items before executing it.
Public method IDTSPackageSigning100_CheckSignature Infrastructure. Checks the signature of the package.
Public method IDTSPackageSigning100_LoadUserCertificateByHash Infrastructure. Loads the user certificate using hash.
Public method IDTSPackageSigning100_LoadUserCertificateByName Infrastructure. Loads the user certificate by name.
Public method IDTSSuspend100_ResumeExecution Infrastructure. Resumes the execution of the task after pausing.
Public method IDTSSuspend100_SuspendExecution Infrastructure. Notifies that the executable needs to suspend.
Public method ImportConfigurationFile Infrastructure. Loads a configuration file associated with the package.
Public method LoadFromXML Infrastructure. Loads a package and all its objects that have been saved to memory in XML format.
Public method LoadUserCertificateByHash Infrastructure. Loads the user certificate using hash.
Public method LoadUserCertificateByName Infrastructure. Loads the user certificate by name.
Protected method MemberwiseClone (Inherited from Object.)
Public method PasswordMatch Infrastructure. Determines whether the specified password matches with the package password.
Public method PermitUnencryptedSave Infrastructure. Permits the unencrypted information to save.
Public method ProcessConfiguration Infrastructure. Specifies the configuration information for a package and its objects.
Public method RegenerateID Infrastructure. Creates a new GUID for the package and updates the package ID property.
Public method ResumeExecution Infrastructure. Resumes the execution of the package after pausing.
Public method SaveToXML Infrastructure. Saves the package to memory in an XML format.
Public method SetExpression Infrastructure. Assigns the specified expression to the property.
Public method SetProject Infrastructure. Sets the specified project.
Public method SuspendExecution Infrastructure. Called when the executable needs to suspend. This method is called by the runtime engine.
Public method ToString (Inherited from Object.)
Public method Validate Infrastructure. Allows the package to determine if it contains invalid settings that will prevent it from executing successfully.

Top

Remarks

For more information, see Package.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Dts.Runtime.Wrapper Namespace