Share via


Application Class

Discovers and accesses Package objects. It can also access collections and properties that contain information about the system.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Application

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

Syntax

'Declaration
Public Class Application _
    Inherits DtsObject
'Usage
Dim instance As Application
public class Application : DtsObject
public ref class Application : public DtsObject
type Application =  
    class 
        inherit DtsObject 
    end
public class Application extends DtsObject

The Application type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property CheckSignatureOnLoad Gets or sets a value that indicates whether the runtime should check the digital signature of the package when loading the package.
Public property ComponentStorePath Returns the path where pipeline components are stored. This property is read-only.
Public property ConnectionInfos Returns a ConnectionInfos collection that contains ConnectionInfo objects. This property is read-only.
Public property DataTypeInfos Returns a DataTypeInfos collection that contains DataTypeInfo objects. This property is read-only.
Public property DBProviderInfos Returns a DBProviderInfos collection that contains DBProviderInfo objects in the application. This property is read-only.
Public property DumpDescriptor Gets or sets the dump descriptor for the application.
Public property DumpOnAnyError Gets or sets whether the application dumps on any error.
Public property EnableDump Gets or sets whether the application enables dumping.
Public property ForEachEnumeratorInfos Returns a ForEachEnumeratorInfos collection that contains ForEachEnumeratorInfo objects. This property is read-only.
Public property LogProviderInfos Returns a LogProviderInfos collection that contains LogProviderInfo objects. This property is read-only.
Public property PackagePassword Sets the value of the password for the package. This property is write-only.
Public property PackageUpgradeOptions Gets or sets a value that indicates which upgrade options will be applied to a collection of Integration Services packages during the upgrade process.
Public property PipelineComponentInfos Returns a PipelineComponentInfos collection that contains PipelineComponentInfo objects.
Public property TaskInfos Returns a TaskInfos collection that contains TaskInfo objects. This property is read-only.
Public property UpdateObjects *** Member deprecated; see Remarks. ***    Gets or sets a Boolean that indicates whether extensible objects can be updated at package load time if an updated version is found.
Public property UpdatePackage Gets or sets a Boolean that indicates whether packages can be updated when an updated version is found.

Top

Methods

  Name Description
Public method CreateFolderOnDtsServer Creates a folder on the server that appears in the Stored Packages node of the Integration Services service hierarchy. 
Public method CreateFolderOnSqlServer Creates a folder on the specified instance of SQL Server.
Public method CreateSsisServerExecution Creates SSIS server execution.
Public method DataTypeInfoFromDataType Returns the DataTypeInfo object for the specified data type.
Public method Equals Determines whether two object instances are equal. (Inherited from DtsObject.)
Public method ExistsOnDtsServer Returns a Boolean that indicates whether the specified package already exists on the Integration Services service.
Public method ExistsOnSqlServer Returns a Boolean that indicates whether the specified package exists on the instance of SQL Server.
Protected method Finalize (Inherited from Object.)
Public method FolderExistsOnDtsServer Returns a Boolean that indicates whether the specified folder already exists on the file system.
Public method FolderExistsOnSqlServer Returns a Boolean that indicates whether the specified folder already exists on the instance of SQL Server.
Public method GetDtsServerPackageInfos Gets a PackageInfos collection that contains the packages stored in the SSIS Package Store on an instance of SQL Server, within the specified folder.
Public method GetDtsServerRoles Returns an array of Strings that lists the roles available for a folder.
Public method GetHashCode Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetPackageInfos Gets a PackageInfos collection that contains the packages stored in an instance of SQL Server, within the specified logical folder, by using the server name, user name, and password.
Public method GetPackageInfos2 Infrastructure. Gets a PackageInfos collection that contains the packages stored in an instance of SQL Server, within the specified logical folder, by using the server name, user name, and password.
Public method GetPackageRoles Returns the database roles that have read access and write access to the package. Database roles apply only to packages stored in the SQL Server msdb database.
Public method GetRunningPackages Returns a RunningPackages collection that contains RunningPackage objects. This property is read-only.
Public method GetServerInfo Returns the SQL Server version number of the SQL Server product installed on the target server. 
Public method GetServerVersionEx Returns the edition, product level, and other values that indicate the version of SSIS installed.
Public method GetType (Inherited from Object.)
Public method LoadFromDtsServer Loads a package from the specified server.
Public method LoadFromSqlServer Loads a package from SQL Server by specifying the server name, user name, and password.
Public method LoadFromSqlServer2 Infrastructure. Loads a package from SQL Server by specifying the server name, user name, and password.
Public method LoadPackage(String, IDTSEvents) Loads a Package from the file system.
Public method LoadPackage(String, IDTSEvents, Boolean) Loads a Package from the file system, and specifies the threading model.
Protected method MemberwiseClone (Inherited from Object.)
Public method RemoveFolderFromDtsServer Removes the specified folder from the specified server.
Public method RemoveFolderFromSqlServer Removes the specified folder from the specified instance of SQL Server.
Public method RemoveFromDtsServer Removes a package from the specified server.
Public method RemoveFromSqlServer Removes a package from the specified instance of SQL Server.
Public method RenameFolderOnDtsServer Renames a folder on the specified instance of SQL Server.
Public method RenameFolderOnSqlServer Renames a folder on the specified instance of SQL Server.
Public method SaveToDtsServer Saves a package to the file system.
Public method SaveToSqlServer Saves a package to an instance of SQL Server.
Public method SaveToSqlServerAs Saves a package to an instance of SQL Server with a new name.
Public method SaveToXml Saves the XML definition of a package to a file.
Public method SetPackageRoles Sets the database roles that have read access and write access to the package. Database roles apply only to package stored in the SQL Server msdb database.
Public method ToString (Inherited from Object.)
Public method Upgrade Upgrades one or more Integration Services packages from a specified source location to a specified destination location.

Top

Remarks

The Application object is a system discovery and package access mechanism.

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 Namespace