Parameter Class

Article
04/26/2013

Represents an abstract base class used by both package parameter and project parameter.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public MustInherit Class Parameter _
    Inherits DtsObject _
    Implements IComponent, IDisposable, IDTSName, IDTSPersist
'Usage
Dim instance As Parameter

public abstract class Parameter : DtsObject, 
    IComponent, IDisposable, IDTSName, IDTSPersist

public ref class Parameter abstract : public DtsObject, 
    IComponent, IDisposable, IDTSName, IDTSPersist

[<AbstractClassAttribute>]
type Parameter =  
    class 
        inherit DtsObject 
        interface IComponent 
        interface IDisposable 
        interface IDTSName 
        interface IDTSPersist 
    end

public abstract class Parameter extends DtsObject implements IComponent, IDisposable, IDTSName, IDTSPersist

The Parameter type exposes the following members.

Constructors

	Name	Description
	Parameter	Initializes a new instance of the Parameter class.

Top

Properties

	Name	Description
	CreationName	Gets the name used to create the Parameter object.
	DataType	Gets the data type of the Parameter object.
	Description	Gets or sets the description of the Parameter object.
	ID	Gets the identifier of the Parameter object.
	IncludeInDebugDump	Infrastructure. Gets or sets a value that indicates whether the Parameter object is included in a debug dump.
	Name	Gets or sets the name of the Parameter object.
	Required	Gets or sets a value that indicates whether the Parameter object is a required parameter. If this value is true, a value must be assigned before a project or package can be executed.
	Sensitive	Gets or sets a value that indicates whether the Parameter object contains sensitive data. If this value is true, the value is encrypted in the Integration Services catalog.
	Site	Gets or sets the ISite interface associated with the Parameter object.
	Value	Gets or sets the value of the Parameter object.

Top

Methods

	Name	Description
	CheckParameterName	Validates the specified parameter name.
	Dispose	Releases all resources used by the current instance of the Parameter class.
	Equals	Determines whether two object instances are equal. (Inherited from DtsObject.)
	Finalize	(Inherited from Object.)
	GetHashCode	Returns the hash code for this instance. (Inherited from DtsObject.)
	GetType	(Inherited from Object.)
	LoadFromXML	Loads a package and all its objects that have been saved to memory in XML format.
	MemberwiseClone	(Inherited from Object.)
	SaveToXML	Saves the XML definition of a package to a file.
	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