PackageClass Class
TOC
Collapse the table of content
Expand the table of content

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.

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

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

No code example is currently available or this language may not be supported.

NameDescription
System_CAPS_pubmethodPackageClass()

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.

NameDescription
System_CAPS_pubpropertyCertificateContext

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.

System_CAPS_pubpropertyCertificateObject

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.

System_CAPS_pubpropertyCheckpointFileName

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.

System_CAPS_pubpropertyCheckpointUsage

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.

System_CAPS_pubpropertyCheckSignatureOnLoad

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.

System_CAPS_pubpropertyConfigurations

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.

System_CAPS_pubpropertyConnections

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.

System_CAPS_pubpropertyCreationDate

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.

System_CAPS_pubpropertyCreationName

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.

System_CAPS_pubpropertyCreatorComputerName

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.

System_CAPS_pubpropertyCreatorName

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.

System_CAPS_pubpropertyDebugMode

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.

System_CAPS_pubpropertyDelayValidation

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.

System_CAPS_pubpropertyDescription

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.

System_CAPS_pubpropertyDesignEvents

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.

System_CAPS_pubpropertyDesignTimeProperties

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.

System_CAPS_pubpropertyDisable

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.

System_CAPS_pubpropertyDisableEventHandlers

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.

System_CAPS_pubpropertyDumpDescriptor

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.

System_CAPS_pubpropertyDumpOnAnyError

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.

System_CAPS_pubpropertyEnableConfigurations

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.

System_CAPS_pubpropertyEnableDump

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.

System_CAPS_pubpropertyEncryptCheckpoints

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.

System_CAPS_pubpropertyErrors

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.

System_CAPS_pubpropertyEventHandlers

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a collection of event handler objects.

System_CAPS_pubpropertyEventInfos

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.

System_CAPS_pubpropertyExecutables

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.

System_CAPS_pubpropertyExecutionDuration

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.

System_CAPS_pubpropertyExecutionResult

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.

System_CAPS_pubpropertyExecutionStatus

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the current status of the execution.

System_CAPS_pubpropertyExtendedProperties

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the IDTSExtendedProperties100 collection for the package.

System_CAPS_pubpropertyFailPackageOnFailure

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.

System_CAPS_pubpropertyFailParentOnFailure

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.

System_CAPS_pubpropertyForcedExecutionValue

This API supports the product infrastructure and is not intended to be used directly from your code. If the ForceExecutionValue property is set to true, gets or sets a value that specifies the optional execution value that the package returns.

System_CAPS_pubpropertyForceExecutionResult

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.

System_CAPS_pubpropertyForceExecutionValue

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.

System_CAPS_pubpropertyID

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the ID of the package.

System_CAPS_pubpropertyIDTSPackageSigning100_CertificateContext

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the certificate context.

System_CAPS_pubpropertyIDTSPackageSigning100_CertificateObject

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the certificate object.

System_CAPS_pubpropertyIDTSPackageSigning100_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.

System_CAPS_pubpropertyIDTSSuspend100_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.

System_CAPS_pubpropertyIgnoreConfigurationsOnLoad

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.

System_CAPS_pubpropertyInteractiveMode

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.

System_CAPS_pubpropertyIsDefaultLocaleID

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.

System_CAPS_pubpropertyIsolationLevel

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.

System_CAPS_pubpropertyLastModifiedProductVersion

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.

System_CAPS_pubpropertyLocaleID

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.

System_CAPS_pubpropertyLogEntryInfos

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a collection of log entry definitions.

System_CAPS_pubpropertyLoggingMode

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.

System_CAPS_pubpropertyLoggingOptions

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.

System_CAPS_pubpropertyLogProviders

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.

System_CAPS_pubpropertyMaxConcurrentExecutables

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.

System_CAPS_pubpropertyMaximumErrorCount

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.

System_CAPS_pubpropertyName

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.

System_CAPS_pubpropertyOfflineMode

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.

System_CAPS_pubpropertyPackageFormatVersion

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the format version of the package.

System_CAPS_pubpropertyPackageLocation

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the location of the package.

System_CAPS_pubpropertyPackagePassword

This API supports the product infrastructure and is not intended to be used directly from your code. Sets the password for the package.

System_CAPS_pubpropertyPackagePriorityClass

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.

System_CAPS_pubpropertyPackageType

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.

System_CAPS_pubpropertyPackageUpgradeOptions

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.

System_CAPS_pubpropertyParent

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the parent of the package.

System_CAPS_pubpropertyPrecedenceConstraints

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.

System_CAPS_pubpropertyProperties

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.

System_CAPS_pubpropertyProtectionLevel

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.

System_CAPS_pubpropertySafeRecursiveProjectPackageExecution

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.

System_CAPS_pubpropertySaveCheckpoints

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.

System_CAPS_pubpropertySQLFolder

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.

System_CAPS_pubpropertyStartTime

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.

System_CAPS_pubpropertyStopTime

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.

System_CAPS_pubpropertySuppressConfigurationWarnings

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.

System_CAPS_pubpropertySuspendRequired

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.

System_CAPS_pubpropertyTransactionOption

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.

System_CAPS_pubpropertyUpdateObjects

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.

System_CAPS_pubpropertyUpdatePackage

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.

System_CAPS_pubpropertyVariableDispenser

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.

System_CAPS_pubpropertyVariables

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.

System_CAPS_pubpropertyVersionBuild

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.

System_CAPS_pubpropertyVersionComments

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.

System_CAPS_pubpropertyVersionGUID

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.

System_CAPS_pubpropertyVersionMajor

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.

System_CAPS_pubpropertyVersionMinor

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.

System_CAPS_pubpropertyWarnings

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.

NameDescription
System_CAPS_pubmethodAcceptBreakpointManager(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.

System_CAPS_pubmethodCheckSignature()

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.

System_CAPS_pubmethodComputeExpressions(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.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodExecute()

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.

System_CAPS_pubmethodExecute(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.

System_CAPS_pubmethodExportConfigurationFile(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.

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodFindReferencedObjects(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a reference object enumeration.

System_CAPS_pubmethodGetBreakpointTargets(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.

System_CAPS_pubmethodGetExpression(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.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetObjectFromPackagePath(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.

System_CAPS_pubmethodGetParentID()

This API supports the product infrastructure and is not intended to be used directly from your code. Retrieves the parent identifier of the package.

System_CAPS_pubmethodGetPreExecutionPackageXML(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.

System_CAPS_pubmethodGetProject()

This API supports the product infrastructure and is not intended to be used directly from your code. Retrieves the DTS project.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodIDTSExecutable100_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.

System_CAPS_pubmethodIDTSExecutable100_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.

System_CAPS_pubmethodIDTSPackageSigning100_CheckSignature()

This API supports the product infrastructure and is not intended to be used directly from your code. Checks the signature of the package.

System_CAPS_pubmethodIDTSPackageSigning100_LoadUserCertificateByHash(Byte[])

This API supports the product infrastructure and is not intended to be used directly from your code. Loads the user certificate using hash.

System_CAPS_pubmethodIDTSPackageSigning100_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.

System_CAPS_pubmethodIDTSSuspend100_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.

System_CAPS_pubmethodIDTSSuspend100_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.

System_CAPS_pubmethodImportConfigurationFile(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.

System_CAPS_pubmethodLoadFromXML(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.

System_CAPS_pubmethodLoadUserCertificateByHash(Byte[])

This API supports the product infrastructure and is not intended to be used directly from your code. Loads the user certificate using hash.

System_CAPS_pubmethodLoadUserCertificateByName(String)

This API supports the product infrastructure and is not intended to be used directly from your code. Loads the user certificate by name.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodPasswordMatch(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.

System_CAPS_pubmethodPermitUnencryptedSave(Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. Permits the unencrypted information to save.

System_CAPS_pubmethodProcessConfiguration(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.

System_CAPS_pubmethodRegenerateID()

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.

System_CAPS_pubmethodResumeExecution()

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.

System_CAPS_pubmethodSaveToXML(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.

System_CAPS_pubmethodSetExpression(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.

System_CAPS_pubmethodSetProject(IDTSProject100, String)

This API supports the product infrastructure and is not intended to be used directly from your code. Sets the specified project.

System_CAPS_pubmethodSuspendExecution()

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.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodValidate(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.

For more information, see Package.

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

Return to top
Show:
© 2016 Microsoft