Project Class

Represents Integration Services project which contains packages and parameters.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<ComVisibleAttribute(True)> _
Public NotInheritable Class Project _
    Inherits DtsObject _
    Implements IComponent, IDisposable
'Usage
Dim instance As Project
[ComVisibleAttribute(true)]
public sealed class Project : DtsObject, 
    IComponent, IDisposable
[ComVisibleAttribute(true)]
public ref class Project sealed : public DtsObject, 
    IComponent, IDisposable
[<SealedAttribute>]
[<ComVisibleAttribute(true)>]
type Project =  
    class 
        inherit DtsObject 
        interface IComponent 
        interface IDisposable 
    end
public final class Project extends DtsObject implements IComponent, IDisposable

The Project type exposes the following members.

Properties

  Name Description
Public property ConnectionManagerItems Gets the connection manager items of the project. The connection managers are shared across all packages.
Public property CreationDate Gets or sets the date and time that the project was created.
Public property CreatorComputerName Gets or sets the name of the computer on which the project was created.
Public property CreatorName Gets or sets the name of the individual who created the project.
Public property Description Gets or sets the description of the Project object.
Public property Events Sets the IDTSEvents interface to get various events.
Public property FormatVersion Gets the format version of the project.
Public property ID Gets the project ID, which is GUID.
Public property Name Gets or sets the name of the project.
Public property OfflineMode Gets or sets a value that indicates whether the project is on offline mode.
Public property PackageItems Gets the collection of the package items for the project.
Public property Parameters Gets the collection of the project parameters.
Public property Password Sets the password used to encrypt or decrypt project and packages.
Public property ProtectionLevel Gets or sets the level of protection on the project.
Public property Site Gets or sets the ISite associated with the parameter object.
Public property VersionBuild Gets or sets the build version of the project.
Public property VersionComments Gets or sets the comments associated with the project.
Public property VersionMajor Gets or sets the major build version of the project.
Public property VersionMinor Gets or sets the minor build version of the project.

Top

Methods

  Name Description
Public methodStatic member CreateProject() Creates a new Integration Services project.
Public methodStatic member CreateProject(Stream) Creates a new project on a given I/O stream.
Public methodStatic member CreateProject(String) Creates a new project in the specified file.
Public method Dispose Releases all resources used by the current instance of the Project class.
Public method Equals Determines whether two object instances are equal. (Inherited from DtsObject.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetType (Inherited from Object.)
Public methodStatic member OpenProject(Stream) Opens a project from an I/O stream.
Public methodStatic member OpenProject(String) Opens an existing project in the specified file.
Public methodStatic member OpenProject(Stream, IDTSEvents) Opens a project from an I/O stream and specifies an event listener to receive events.
Public methodStatic member OpenProject(Stream, String) Opens a password protected project from an I/O stream.
Public methodStatic member OpenProject(String, IDTSEvents) Opens an existing project in the specified file.
Public methodStatic member OpenProject(String, String) Opens an existing project with password in the specified file.
Public methodStatic member OpenProject(Stream, String, IDTSEvents) Opens a password protected project from an I/O stream and specifies an event listener to receive events.
Public methodStatic member OpenProject(String, String, IDTSEvents) Opens an existing project in the specified file.
Public methodStatic member OpenProject(Stream, Project.AccessMode, String, IDTSEvents) Opens a password protected project from an I/O stream and specifies an event listener to receive events.
Public methodStatic member OpenProject(String, Project.AccessMode, String, IDTSEvents) Opens a password protected project in the specified path and specifies an event listener to receive events.
Public method Save Saves the project to its corresponding storage. DtsException is thrown if the project doesn’t have corresponding storage.
Public method SaveAs(Stream) Saves the project to the specified I/O stream. The specified stream becomes the project storage.
Public method SaveAs(String) Saves the project to the specified storage. The specified file becomes the storage for the project if saving successes.
Public method SaveTo(Stream) Saves the project to the specified I/O stream. Unlike SaveAs, project storage is not changed after saving.
Public method SaveTo(String) Saves the project to the specified file. Unlike SaveAs, project storage is not changed after saving.
Public method ToString (Inherited from Object.)

Top

Events

  Name Description
Public event Disposed Occurs when the component is disposed by a call to the Dispose method.

Top

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