Export (0) Print
Expand All

PackageClass Class

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.

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

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

[DefaultMemberAttribute(L"StartTime")]
[ClassInterfaceAttribute(ClassInterfaceType::None)]
[GuidAttribute(L"02102D82-3E9A-48AE-8A3F-AC8C01F4A044")]
[TypeLibTypeAttribute(TypeLibTypeFlags::FCanCreate)]
public ref class PackageClass : Package, 
	IDTSPackage100, IDTSPackageSigning100, IDTSContainer100, IDTSExecutable100, IDTSEventsProvider100, 
	IDTSExecutionMetrics100, IDTSSequence100, IDTSPropertiesProvider100, IDTSName100, IDTSBreakpointSite100, 
	IDTSSuspend100, IDTSPersist100, IDTSRuntimeObject100, IDTSDumpConfiguration100, IDTSConfigurationControl100, 
	IDTSProjectPackage100

The PackageClass type exposes the following members.

  NameDescription
Public methodPackageClassInfrastructure. Initializes a new instance of the PackageClass class.
Top

  NameDescription
Public propertyCertificateContextInfrastructure. Gets or sets the context of the certificate associated with the package.
Public propertyCertificateObjectInfrastructure. Gets or sets the certificate object associated with the package.
Public propertyCheckpointFileNameInfrastructure. Gets or sets the name of the file that captures the checkpoint information, which enables a package to restart.
Public propertyCheckpointUsageInfrastructure. Gets or sets a value that specifies if or when a package is restarted.
Public propertyCheckSignatureOnLoadInfrastructure. Gets or sets a value that indicates whether the digital signature is checked when a package is loaded.
Public propertyConfigurationsInfrastructure. Gets the collection of configurations for the package.
Public propertyConnectionsInfrastructure. Gets the collection of connection managers for the package.
Public propertyCreationDateInfrastructure. Gets or sets the date and time that the package was created.
Public propertyCreationNameInfrastructure. Gets the name used to create the PackageClass object.
Public propertyCreatorComputerNameInfrastructure. Gets or sets the name of the computer on which the package was created.
Public propertyCreatorNameInfrastructure. Gets or sets the name of the individual who created the package.
Public propertyDebugModeInfrastructure. Gets or sets a value that indicates whether the package is in debug mode.
Public propertyDelayValidationInfrastructure. Gets or sets a value that indicates whether package validation is delayed until the package runs.
Public propertyDescriptionInfrastructure. Gets or sets the description of the package.
Public propertyDesignEventsInfrastructure. Gets or sets an IDTSEvents100 that indicates if the designer or other third party client is to receive events during design time.
Public propertyDesignTimePropertiesInfrastructure. Gets or sets the design time properties of a package such as layout information.
Public propertyDisableInfrastructure. Gets or sets a value that indicates whether the PackageClass object is disabled.
Public propertyDisableEventHandlersInfrastructure. Gets or sets a value that indicates whether the event handlers on the package are disabled.
Public propertyDumpDescriptorInfrastructure. Gets or sets the dump descriptor for the package.
Public propertyDumpOnAnyErrorInfrastructure. Gets or sets a value that indicates whether a dump file should be generated when any error occurs during package execution.
Public propertyEnableConfigurationsInfrastructure. Gets or sets a value that indicates whether the package loads configurations.
Public propertyEnableDumpInfrastructure. Gets or sets a value that indicates whether the dump file generation is enabled.
Public propertyEncryptCheckpointsInfrastructure. Gets or sets a value that indicates whether the checkpoint files are encrypted.
Public propertyErrorsInfrastructure. Gets the collection of errors associated with the package.
Public propertyEventHandlersInfrastructure. Gets a collection of event handler objects.
Public propertyEventInfosInfrastructure. Gets the IDTSEventInfos100 collection that is associated with the package.
Public propertyExecutablesInfrastructure. Gets the collection of executable objects contained within the package.
Public propertyExecutionDurationInfrastructure. Gets the amount of time that the package spent in execution, in milliseconds.
Public propertyExecutionResultInfrastructure. Gets a value that indicates the success or failure of the execution of the package.
Public propertyExecutionStatusInfrastructure. Gets the current status of the execution.
Public propertyExtendedPropertiesInfrastructure. Gets the IDTSExtendedProperties100 collection for the package.
Public propertyFailPackageOnFailureInfrastructure. Gets or sets a value that indicates whether the package fails when a task or component in the package fails.
Public propertyFailParentOnFailureInfrastructure. Gets or sets a value that indicates whether the parent package fails when a child package fails.
Public propertyForcedExecutionValueInfrastructure. If the ForceExecutionValue property is set to true, gets or sets a value that specifies the optional execution value that the package returns.
Public propertyForceExecutionResultInfrastructure. Gets or sets a DTSForcedExecResult enumeration value that specifies the forced execution result of the package.
Public propertyForceExecutionValueInfrastructure. Gets or sets a value that indicates whether the execution value of the package should be forced to contain a particular value.
Public propertyIDInfrastructure. Gets the ID of the package.
Public propertyIDTSPackageSigning100_CertificateContextInfrastructure. Gets or sets the certificate context.
Public propertyIDTSPackageSigning100_CertificateObjectInfrastructure. Gets or sets the certificate object.
Public propertyIDTSPackageSigning100_CheckSignatureOnLoadInfrastructure. Gets or sets a value that indicates whether the package checks the signature on loading.
Public propertyIDTSSuspend100_SuspendRequiredInfrastructure. Gets or sets a value that indicates whether the task should suspend when they encounter a breakpoint.
Public propertyIgnoreConfigurationsOnLoadInfrastructure. Gets or sets a value that indicates whether the package ignores configurations when the package is loaded.
Public propertyInteractiveModeInfrastructure. Gets or sets a value that indicates whether the tasks should show user interface objects while executing.
Public propertyIsDefaultLocaleIDInfrastructure. Gets a value that indicates whether the package uses the default locale.
Public propertyIsolationLevelInfrastructure. Gets or sets the isolation level of the transaction in the package.
Public propertyLastModifiedProductVersionInfrastructure. Gets the product version of the last modified package.
Public propertyLocaleIDInfrastructure. Gets or sets the identifier of the locale used by a package.
Public propertyLogEntryInfosInfrastructure. Gets a collection of log entry definitions.
Public propertyLoggingModeInfrastructure. Gets or sets the logging mode of the package.
Public propertyLoggingOptionsInfrastructure. Gets the filtering and logging resource for the package.
Public propertyLogProvidersInfrastructure. Gets the collection of log providers associated with the package.
Public propertyMaxConcurrentExecutablesInfrastructure. Gets or sets the number of threads that a package can create.
Public propertyMaximumErrorCountInfrastructure. Gets or sets the maximum number of errors that can occur before the package stops running.
Public propertyNameInfrastructure. Gets or sets the name of the PackageClass.
Public propertyOfflineModeInfrastructure. Gets or sets a value that indicates whether the package is working in offline mode.
Public propertyPackageFormatVersionInfrastructure. Gets the format version of the package.
Public propertyPackageLocationInfrastructure. Gets the location of the package.
Public propertyPackagePasswordInfrastructure. Sets the password for the package.
Public propertyPackagePriorityClassInfrastructure. Gets or sets the Win32 thread priority class of the package thread.
Public propertyPackageTypeInfrastructure. Gets or sets a value that identifies the tool that created the package.
Public propertyPackageUpgradeOptionsInfrastructure. Gets or sets the upgrade options for the package.
Public propertyParentInfrastructure. Gets the parent of the package.
Public propertyPrecedenceConstraintsInfrastructure. Gets a collection of precedence constraints for the package.
Public propertyPropertiesInfrastructure. Gets a collection of properties for the package.
Public propertyProtectionLevelInfrastructure. Gets or sets the level of protection on the package.
Public propertySafeRecursiveProjectPackageExecutionInfrastructure. Gets or sets a value that indicates whether recursive execution of the package is safe.
Public propertySaveCheckpointsInfrastructure. Gets or sets a value that indicates whether the package will use checkpoints during package execution.
Public propertySQLFolderInfrastructure. Gets or sets the SQL folder for the package.
Public propertyStartTimeInfrastructure. Gets the time when the package starts execution.
Public propertyStopTimeInfrastructure. Gets the time when the package stops execution.
Public propertySuppressConfigurationWarningsInfrastructure. Gets or sets a value that indicates whether the warnings generated by configurations are suppressed.
Public propertySuspendRequiredInfrastructure. Gets or sets a value that indicates whether the tasks should suspend when they encounter a breakpoint.
Public propertyTransactionOptionInfrastructure. Gets or sets a DTSTransactionOption enumeration value that indicates whether the package participates in transaction.
Public propertyUpdateObjectsInfrastructure. 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 propertyUpdatePackageInfrastructure. Gets or sets a value that indicates whether the packages can be updated when an updated version is found.
Public propertyVariableDispenserInfrastructure. Gets the dispenser of the variables in the package.
Public propertyVariablesInfrastructure. Gets a collection that contains the variables associated with the package.
Public propertyVersionBuildInfrastructure. Gets or sets the build version of the package.
Public propertyVersionCommentsInfrastructure. Gets or sets the version comments associated with the package.
Public propertyVersionGUIDInfrastructure. Gets the version GUID generated when the package is first created.
Public propertyVersionMajorInfrastructure. Gets or sets the major build version of the package.
Public propertyVersionMinorInfrastructure. Gets or sets the minor build version of the package.
Public propertyWarningsInfrastructure. Gets the collection of warnings set on the package.
Top

  NameDescription
Public methodAcceptBreakpointManagerInfrastructure. Passes a breakpoint manager to a package.
Public methodCheckSignatureInfrastructure. Checks the status of the digital signature of the package.
Public methodComputeExpressionsInfrastructure. Computes the expression of this PackageClass object.
Public methodEquals (Inherited from Object.)
Public methodExecute()Infrastructure. Returns a DTSExecResult enumeration that contains information about the success or failure of the package execution.
Public methodExecute(IDTSConnections100, IDTSVariables100, IDTSEvents100, IDTSLogging100, Object)Infrastructure. Runs the application, container, or package as part of a package workflow.
Public methodExportConfigurationFileInfrastructure. Creates an XML file that contains all deployable variables in the package.
Protected methodFinalize (Inherited from Object.)
Public methodFindReferencedObjectsInfrastructure. Returns a reference object enumeration.
Public methodGetBreakpointTargetsInfrastructure. 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 methodGetExpressionInfrastructure. Returns a value that contains the expression for the specified property.
Public methodGetHashCode (Inherited from Object.)
Public methodGetObjectFromPackagePathInfrastructure. Returns an object from the specified package path.
Public methodGetParentIDInfrastructure. Retrieves the parent identifier of the package.
Public methodGetPreExecutionPackageXMLInfrastructure. Retrieves the pre-execution of a package XML.
Public methodGetProjectInfrastructure. Retrieves the DTS project.
Public methodGetType (Inherited from Object.)
Public methodIDTSExecutable100_ExecuteInfrastructure. Executes the executable.
Public methodIDTSExecutable100_ValidateInfrastructure. Verifies that the executable will successfully execute by validating all its dependencies and other items before executing it.
Public methodIDTSPackageSigning100_CheckSignatureInfrastructure. Checks the signature of the package.
Public methodIDTSPackageSigning100_LoadUserCertificateByHashInfrastructure. Loads the user certificate using hash.
Public methodIDTSPackageSigning100_LoadUserCertificateByNameInfrastructure. Loads the user certificate by name.
Public methodIDTSSuspend100_ResumeExecutionInfrastructure. Resumes the execution of the task after pausing.
Public methodIDTSSuspend100_SuspendExecutionInfrastructure. Notifies that the executable needs to suspend.
Public methodImportConfigurationFileInfrastructure. Loads a configuration file associated with the package.
Public methodLoadFromXMLInfrastructure. Loads a package and all its objects that have been saved to memory in XML format.
Public methodLoadUserCertificateByHashInfrastructure. Loads the user certificate using hash.
Public methodLoadUserCertificateByNameInfrastructure. Loads the user certificate by name.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodPasswordMatchInfrastructure. Determines whether the specified password matches with the package password.
Public methodPermitUnencryptedSaveInfrastructure. Permits the unencrypted information to save.
Public methodProcessConfigurationInfrastructure. Specifies the configuration information for a package and its objects.
Public methodRegenerateIDInfrastructure. Creates a new GUID for the package and updates the package ID property.
Public methodResumeExecutionInfrastructure. Resumes the execution of the package after pausing.
Public methodSaveToXMLInfrastructure. Saves the package to memory in an XML format.
Public methodSetExpressionInfrastructure. Assigns the specified expression to the property.
Public methodSetProjectInfrastructure. Sets the specified project.
Public methodSuspendExecutionInfrastructure. Called when the executable needs to suspend. This method is called by the runtime engine.
Public methodToString (Inherited from Object.)
Public methodValidateInfrastructure. Allows the package to determine if it contains invalid settings that will prevent it from executing successfully.
Top

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.

Community Additions

ADD
Show:
© 2014 Microsoft