PackageClass Class
This API supports the product infrastructure and is not intended to be used directly from your code.
Represents a class for the Package interface.
Assembly: Microsoft.SqlServer.DTSRuntimeWrap (in Microsoft.SqlServer.DTSRuntimeWrap.dll)
[ClassInterfaceAttribute(ClassInterfaceType::None)] [TypeLibTypeAttribute(TypeLibTypeFlags::FCanCreate)] [GuidAttribute("02102D82-3E9A-48AE-8A3F-AC8C01F4A044")] [DefaultMemberAttribute("StartTime")] public ref class PackageClass : Package, IDTSPackage100, IDTSPackageSigning100, IDTSContainer100, IDTSExecutable100, IDTSEventsProvider100, IDTSExecutionMetrics100, IDTSSequence100, IDTSPropertiesProvider100, IDTSName100, IDTSBreakpointSite100, IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100, IDTSDumpConfiguration100, IDTSConfigurationControl100, IDTSProjectPackage100
| Name | Description | |
|---|---|---|
![]() | PackageClass() | This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the PackageClass class. |
| Name | Description | |
|---|---|---|
![]() | CertificateContext | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the context of the certificate associated with the package. |
![]() | CertificateObject | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the certificate object associated with the package. |
![]() | CheckpointFileName | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the name of the file that captures the checkpoint information, which enables a package to restart. |
![]() | CheckpointUsage | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that specifies if or when a package is restarted. |
![]() | CheckSignatureOnLoad | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the digital signature is checked when a package is loaded. |
![]() | Configurations | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the collection of configurations for the package. |
![]() | Connections | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the collection of connection managers for the package. |
![]() | CreationDate | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the date and time that the package was created. |
![]() | CreationName | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the name used to create the PackageClass object. |
![]() | CreatorComputerName | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the name of the computer on which the package was created. |
![]() | CreatorName | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the name of the individual who created the package. |
![]() | DebugMode | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the package is in debug mode. |
![]() | DelayValidation | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether package validation is delayed until the package runs. |
![]() | Description | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the description of the package. |
![]() | DesignEvents | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets an IDTSEvents100 that indicates if the designer or other third party client is to receive events during design time. |
![]() | DesignTimeProperties | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the design time properties of a package such as layout information. |
![]() | Disable | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the PackageClass object is disabled. |
![]() | DisableEventHandlers | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the event handlers on the package are disabled. |
![]() | DumpDescriptor | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the dump descriptor for the package. |
![]() | DumpOnAnyError | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether a dump file should be generated when any error occurs during package execution. |
![]() | EnableConfigurations | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the package loads configurations. |
![]() | EnableDump | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the dump file generation is enabled. |
![]() | EncryptCheckpoints | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the checkpoint files are encrypted. |
![]() | Errors | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the collection of errors associated with the package. |
![]() | EventHandlers | This API supports the product infrastructure and is not intended to be used directly from your code. Gets a collection of event handler objects. |
![]() | EventInfos | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the IDTSEventInfos100 collection that is associated with the package. |
![]() | Executables | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the collection of executable objects contained within the package. |
![]() | ExecutionDuration | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the amount of time that the package spent in execution, in milliseconds. |
![]() | ExecutionResult | This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value that indicates the success or failure of the execution of the package. |
![]() | ExecutionStatus | This API supports the product infrastructure and is not intended to be used directly from your code. Gets execution status. |
![]() | ExtendedProperties | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the IDTSExtendedProperties100 collection for the package. |
![]() | FailPackageOnFailure | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the package fails when a task or component in the package fails. |
![]() | FailParentOnFailure | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the parent package fails when a child package fails. |
![]() | ForcedExecutionValue | This API supports the product infrastructure and is not intended to be used directly from your code. If the ForcedExecutionValue property is set to true, gets or sets a value that specifies the optional execution value that the package returns. |
![]() | ForceExecutionResult | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the package. |
![]() | ForceExecutionValue | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the execution value of the package should be forced to contain a particular value. |
![]() | ID | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the ID of the package. |
![]() | IDTSPackageSigning100_CertificateContext | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the certificate context. |
![]() | IDTSPackageSigning100_CertificateObject | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the certificate object. |
![]() | IDTSPackageSigning100_CheckSignatureOnLoad | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the package checks the signature on loading. |
![]() | IDTSSuspend100_SuspendRequired | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the task should suspend when they encounter a breakpoint. |
![]() | IgnoreConfigurationsOnLoad | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the package ignores configurations when the package is loaded. |
![]() | InteractiveMode | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the tasks should show user interface objects while executing. |
![]() | IsDefaultLocaleID | This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value that indicates whether the package uses the default locale. |
![]() | IsolationLevel | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the isolation level of the transaction in the package. |
![]() | LastModifiedProductVersion | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the product version of the last modified package. |
![]() | LocaleID | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the identifier of the locale used by a package. |
![]() | LogEntryInfos | This API supports the product infrastructure and is not intended to be used directly from your code. Gets a collection of log entry definitions. |
![]() | LoggingMode | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the logging mode of the package. |
![]() | LoggingOptions | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the filtering and logging resource for the package. |
![]() | LogProviders | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the collection of log providers associated with the package. |
![]() | MaxConcurrentExecutables | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the number of threads that a package can create. |
![]() | MaximumErrorCount | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the maximum number of errors that can occur before the package stops running. |
![]() | Name | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the name of the PackageClass. |
![]() | OfflineMode | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the package is working in offline mode. |
![]() | PackageFormatVersion | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the format version of the package. |
![]() | PackageLocation | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the location of the package. |
![]() | PackagePassword | This API supports the product infrastructure and is not intended to be used directly from your code. Sets the password for the package. |
![]() | PackagePriorityClass | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the Win32 thread priority class of the package thread. |
![]() | PackageType | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that identifies the tool that created the package. |
![]() | PackageUpgradeOptions | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the upgrade options for the package. |
![]() | Parent | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the parent of the package. |
![]() | PrecedenceConstraints | This API supports the product infrastructure and is not intended to be used directly from your code. Gets a collection of precedence constraints for the package. |
![]() | Properties | This API supports the product infrastructure and is not intended to be used directly from your code. Gets a collection of properties for the package. |
![]() | ProtectionLevel | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the level of protection on the package. |
![]() | SafeRecursiveProjectPackageExecution | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether recursive execution of the package is safe. |
![]() | SaveCheckpoints | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the package will use checkpoints during package execution. |
![]() | SQLFolder | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the SQL folder for the package. |
![]() | StartTime | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the time when the package starts execution. |
![]() | StopTime | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the time when the package stops execution. |
![]() | SuppressConfigurationWarnings | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the warnings generated by configurations are suppressed. |
![]() | SuspendRequired | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the tasks should suspend when they encounter a breakpoint. |
![]() | TransactionOption | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a DTSTransactionOption enumeration value that indicates whether the package participates in transaction. |
![]() | UpdateObjects | This API supports the product infrastructure and is not intended to be used directly from your code. 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 | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the packages can be updated when an updated version is found. |
![]() | VariableDispenser | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the dispenser of the variables in the package. |
![]() | Variables | This API supports the product infrastructure and is not intended to be used directly from your code. Gets a collection that contains the variables associated with the package. |
![]() | VersionBuild | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the build version of the package. |
![]() | VersionComments | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the version comments associated with the package. |
![]() | VersionGUID | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the version GUID generated when the package is first created. |
![]() | VersionMajor | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the major build version of the package. |
![]() | VersionMinor | This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the minor build version of the package. |
![]() | Warnings | This API supports the product infrastructure and is not intended to be used directly from your code. Gets the collection of warnings set on the package. |
| Name | Description | |
|---|---|---|
![]() | AcceptBreakpointManager(IDTSBreakpointManager100^) | This API supports the product infrastructure and is not intended to be used directly from your code. Passes a breakpoint manager to a package. |
![]() | CheckSignature() | This API supports the product infrastructure and is not intended to be used directly from your code. Checks the status of the digital signature of the package. |
![]() | ComputeExpressions(Boolean) | This API supports the product infrastructure and is not intended to be used directly from your code. Computes the expression of this PackageClass object. |
![]() | Equals(Object^) | (Inherited from Object.) |
![]() | Execute() | This API supports the product infrastructure and is not intended to be used directly from your code. Returns a DTSExecResult enumeration that contains information about the success or failure of the package execution. |
![]() | Execute(IDTSConnections100^, IDTSVariables100^, IDTSEvents100^, IDTSLogging100^, Object^) | This API supports the product infrastructure and is not intended to be used directly from your code. Runs the application, container, or package as part of a package workflow. |
![]() | ExportConfigurationFile(String^) | This API supports the product infrastructure and is not intended to be used directly from your code. Creates an XML file that contains all deployable variables in the package. |
![]() | Finalize() | (Inherited from Object.) |
![]() | FindReferencedObjects(Object^) | This API supports the product infrastructure and is not intended to be used directly from your code. Returns a reference object enumeration. |
![]() | GetBreakpointTargets(IDTSBreakpointSite100^, Boolean) | This API supports the product infrastructure and is not intended to be used directly from your code. 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^) | This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that contains the expression for the specified property. |
![]() | GetHashCode() | (Inherited from Object.) |
![]() | GetObjectFromPackagePath(String^, IDTSProperty100^%) | This API supports the product infrastructure and is not intended to be used directly from your code. Returns an object from the specified package path. |
![]() | GetParentID() | This API supports the product infrastructure and is not intended to be used directly from your code. Retrieves the parent identifier of the package. |
![]() | GetPreExecutionPackageXML(Object^%) | This API supports the product infrastructure and is not intended to be used directly from your code. Retrieves the pre-execution of a package XML. |
![]() | GetProject() | This API supports the product infrastructure and is not intended to be used directly from your code. Retrieves the DTS project. |
![]() | GetType() | (Inherited from Object.) |
![]() | IDTSExecutable100_Execute(IDTSConnections100^, IDTSVariables100^, IDTSEvents100^, IDTSLogging100^, Object^) | This API supports the product infrastructure and is not intended to be used directly from your code. Executes the executable. |
![]() | IDTSExecutable100_Validate(IDTSConnections100^, IDTSVariables100^, IDTSEvents100^, IDTSLogging100^) | This API supports the product infrastructure and is not intended to be used directly from your code. Verifies that the executable will successfully execute by validating all its dependencies and other items before executing it. |
![]() | IDTSPackageSigning100_CheckSignature() | This API supports the product infrastructure and is not intended to be used directly from your code. Checks the signature of the package. |
![]() | IDTSPackageSigning100_LoadUserCertificateByHash(array<Byte>^%) | This API supports the product infrastructure and is not intended to be used directly from your code. Loads the user certificate using hash. |
![]() | IDTSPackageSigning100_LoadUserCertificateByName(String^) | This API supports the product infrastructure and is not intended to be used directly from your code. Loads the user certificate by name. |
![]() | IDTSSuspend100_ResumeExecution() | This API supports the product infrastructure and is not intended to be used directly from your code. Resumes the execution of the task after pausing. |
![]() | IDTSSuspend100_SuspendExecution() | This API supports the product infrastructure and is not intended to be used directly from your code. Notifies that the executable needs to suspend. |
![]() | ImportConfigurationFile(String^) | This API supports the product infrastructure and is not intended to be used directly from your code. Loads a configuration file associated with the package. |
![]() | LoadFromXML(Object^, IDTSEvents100^) | This API supports the product infrastructure and is not intended to be used directly from your code. Loads a package and all its objects that have been saved to memory in XML format. |
![]() | LoadUserCertificateByHash(array<Byte>^%) | This API supports the product infrastructure and is not intended to be used directly from your code. Loads the user certificate using hash. |
![]() | LoadUserCertificateByName(String^) | This API supports the product infrastructure and is not intended to be used directly from your code. Loads the user certificate by name. |
![]() | MemberwiseClone() | (Inherited from Object.) |
![]() | PasswordMatch(String^) | This API supports the product infrastructure and is not intended to be used directly from your code. Determines whether the specified password matches with the package password. |
![]() | PermitUnencryptedSave(Boolean) | This API supports the product infrastructure and is not intended to be used directly from your code. Permits the unencrypted information to save. |
![]() | ProcessConfiguration(String^, Object^) | This API supports the product infrastructure and is not intended to be used directly from your code. Specifies the configuration information for a package and its objects. |
![]() | RegenerateID() | This API supports the product infrastructure and is not intended to be used directly from your code. Creates a new GUID for the package and updates the package ID property. |
![]() | ResumeExecution() | This API supports the product infrastructure and is not intended to be used directly from your code. Resumes the execution of the package after pausing. |
![]() | SaveToXML(Object^, Object^, IDTSEvents100^) | This API supports the product infrastructure and is not intended to be used directly from your code. Saves the package to memory in an XML format. |
![]() | SetExpression(String^, String^) | This API supports the product infrastructure and is not intended to be used directly from your code. Assigns the specified expression to the property. |
![]() | SetProject(IDTSProject100^, String^) | This API supports the product infrastructure and is not intended to be used directly from your code. Sets the specified project. |
![]() | SuspendExecution() | This API supports the product infrastructure and is not intended to be used directly from your code. Called when the executable needs to suspend. This method is called by the runtime engine. |
![]() | ToString() | (Inherited from Object.) |
![]() | Validate(IDTSConnections100^, IDTSVariables100^, IDTSEvents100^, IDTSLogging100^) | This API supports the product infrastructure and is not intended to be used directly from your code. Allows the package to determine if it contains invalid settings that will prevent it from executing successfully. |
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.


