Parameter Class

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

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

public ref class Parameter abstract : Microsoft::SqlServer::Dts::Runtime::DtsObject, IDisposable, Microsoft::SqlServer::Dts::Runtime::IDTSName, Microsoft::SqlServer::Dts::Runtime::IDTSPersist, System::ComponentModel::IComponent

public abstract class Parameter : Microsoft.SqlServer.Dts.Runtime.DtsObject, IDisposable, Microsoft.SqlServer.Dts.Runtime.IDTSName, Microsoft.SqlServer.Dts.Runtime.IDTSPersist, System.ComponentModel.IComponent

type Parameter = class
    inherit DtsObject
    interface IComponent
    interface IDisposable
    interface IDTSName
    interface IDTSPersist

Public MustInherit Class Parameter
Inherits DtsObject
Implements IComponent, IDisposable, IDTSName, IDTSPersist

Inheritance

Object

DtsObject

Parameter

Implements

IDTSName IDTSPersist IComponent IDisposable

Constructors

Parameter()

Initializes a new instance of the Parameter class.

Properties

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

Methods

CheckParameterName(String)	Validates the specified parameter name.
Dispose()	Releases all resources used by the current instance of the Parameter class.
Equals(Object)	Determines whether two object instances are equal. (Inherited from DtsObject)
GetHashCode()	Returns the hash code for this instance. (Inherited from DtsObject)
LoadFromXML(XmlNode, IDTSEvents)	Loads a package and all its objects that have been saved to memory in XML format.
SaveToXML(XmlDocument, XmlNode, IDTSEvents)	Saves the XML definition of a package to a file.

Events

Disposed

Occurs when the component is disposed by a call to the Dispose() method.