Project Class

Article
2013-04-26

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

Top

Methods

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

Top

Events

	Name	Description
	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.

Share via