Parameter Parameter Parameter Class

Definition

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
Public MustInherit Class Parameter
Inherits DtsObject
Implements IComponent, IDisposable, IDTSName, IDTSPersist
Inheritance
Implements

Constructors

Parameter() Parameter() Parameter()

Initializes a new instance of the Parameter class.

Properties

CreationName CreationName CreationName

Gets the name used to create the Parameter object.

DataType DataType DataType

Gets the data type of the Parameter object.

Description Description Description

Gets or sets the description of the Parameter object.

ID ID ID

Gets the identifier of the Parameter object.

IncludeInDebugDump IncludeInDebugDump IncludeInDebugDump

Gets or sets a value that indicates whether the Parameter object is included in a debug dump.

Name Name Name

Gets or sets the name of the Parameter object.

Required Required 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 Sensitive 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 Site Site

Gets or sets the ISite interface associated with the Parameter object.

Value Value Value

Gets or sets the value of the Parameter object.

Methods

CheckParameterName(String) CheckParameterName(String) CheckParameterName(String)

Validates the specified parameter name.

Dispose() Dispose() Dispose()

Releases all resources used by the current instance of the Parameter class.

Equals(Object) Equals(Object) Equals(Object)

Determines whether two object instances are equal.

(Inherited from DtsObject)
GetHashCode() GetHashCode() GetHashCode()

Returns the hash code for this instance.

(Inherited from DtsObject)
LoadFromXML(XmlNode, IDTSEvents) LoadFromXML(XmlNode, IDTSEvents) LoadFromXML(XmlNode, IDTSEvents)

Loads a package and all its objects that have been saved to memory in XML format.

SaveToXML(XmlDocument, XmlNode, IDTSEvents) SaveToXML(XmlDocument, XmlNode, IDTSEvents) SaveToXML(XmlDocument, XmlNode, IDTSEvents)

Saves the XML definition of a package to a file.

Events

Disposed Disposed Disposed

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

Applies to