Parameter 类

项目
04/26/2013

The Parameter class represents a parameter. It is a base class that is inherited by the StoredProcedureParameter class and the UserDefinedFunctionParameter class and contains common features of both classes.

继承层次结构

命名空间： Microsoft.SqlServer.Management.Smo
程序集： Microsoft.SqlServer.Smo（在 Microsoft.SqlServer.Smo.dll 中）

语法

声明
Public Class Parameter _
    Inherits ParameterBase _
    Implements ISfcSupportsDesignMode
用法
Dim instance As Parameter

public class Parameter : ParameterBase, ISfcSupportsDesignMode

public ref class Parameter : public ParameterBase, 
    ISfcSupportsDesignMode

type Parameter =  
    class 
        inherit ParameterBase 
        interface ISfcSupportsDesignMode 
    end

public class Parameter extends ParameterBase implements ISfcSupportsDesignMode

Parameter 类型公开以下成员。

构造函数

	名称	说明
	Parameter	Initializes a new instance of the Parameter class.

页首

属性

	名称	说明
	DataType	Gets or sets the data type associated with the parameter. （从 ParameterBase 继承。）
	DefaultValue	Gets or sets the default value of the parameter.
	ExecuteForScalar	Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. （从 SqlSmoObject 继承。）
	ExtendedProperties	Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property defined on the ParameterBase object. （从 ParameterBase 继承。）
	ID	Gets the ID value that uniquely identifies the parameter.
	IsReadOnly	Gets or sets whether the parameter is read only.
	IsTouched	Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. （从 SqlSmoObject 继承。）
	Name	Gets or sets a String value that specifies the name of the parameter. （从 ParameterBase 继承。）
	ObjectInSpace	Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server. （从 SqlSmoObject 继承。）
	Properties	Gets a collection of Property objects that represent the object properties. （从 SqlSmoObject 继承。）
	ScalarResult	Gets the scalar result for the referenced object. （从 SqlSmoObject 继承。）
	State	Gets the state of the referenced object. （从 SmoObjectBase 继承。）
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. （从 SqlSmoObject 继承。）
	UserData	Gets or sets user-defined data associated with the referenced object. （从 SmoObjectBase 继承。）

页首

方法

	名称	说明
	AddDatabaseContext	Add the database context to the collection of queries identified by the queries parameter. （从 SqlSmoObject 继承。）
	AlterImpl	Activates the object altered event. （从 SqlSmoObject 继承。）
	AlterImplWorker	Calls the Alter methods. （从 SqlSmoObject 继承。）
	AppendCommaText	Appends text, optionally separated by a comma. （从 ScriptNameObjectBase 继承。）
	AppendWithCommaText	Appends text, optionally separated by a comma. （从 ScriptNameObjectBase 继承。）
	AppendWithOption	Appends text and option text separated from the main text with a “WITH” string and optionally separated by a comma. （从 ScriptNameObjectBase 继承。）
	AutoGenerateName	Generates a name based on the object Guid. （从 ScriptNameObjectBase 继承。）
	BindDefaultImpl	Binds the default items identified by the parameters. （从 SqlSmoObject 继承。）
	BindRuleImpl	Binds the rule schema to the rule and columns identified by the parameters. （从 SqlSmoObject 继承。）
	CheckObjectDirty	Checks whether object has been modified and not persisted. （从 ScriptNameObjectBase 继承。）
	CheckObjectState()	Validates the state of the referenced object. （从 SqlSmoObject 继承。）
	CheckObjectState(Boolean)	Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. （从 SqlSmoObject 继承。）
	CheckObjectStateImpl	Checks the state of a SqlSmoObject. （从 SqlSmoObject 继承。）
	CheckParamName	Checks the parameter name. （从 ParameterBase 继承。）
	CheckTextCorectness	Checks text for correctness against the parameters. （从 ScriptNameObjectBase 继承。）
	CheckTextModeSupport	Checks mode of support. （从 ScriptNameObjectBase 继承。）
	CheckVersion100	Checks whether version of SQL Server is SQL Server 2008. （从 SqlSmoObject 继承。）
	CheckVersion110()	Checks whether version of SQL Server is SQL Server 2012. （从 SqlSmoObject 继承。）
	CheckVersion110(String)	Checks whether the version of SQL Server is SQL Server 2012 with the specified name. （从 SqlSmoObject 继承。）
	CheckVersion80	Checks the validity of the object on SQL Server 2000. （从 SqlSmoObject 继承。）
	CheckVersion80SP3	Checks the validity of the object on SQL Server 2000 SP3. （从 SqlSmoObject 继承。）
	CheckVersion90	Check the validity of the object on SQL Server 2005. （从 SqlSmoObject 继承。）
	CheckVersionBelow110	Checks whether version of SQL Server is before SQL Server 2012. （从 SqlSmoObject 继承。）
	CheckVersionBelow90	Checks whether version of SQL Server is before SQL Server 2005. （从 SqlSmoObject 继承。）
	CleanObject	Cleans the referenced object. （从 ScriptNameObjectBase 继承。）
	CreateImpl	Creates an object with scripting options. （从 SqlSmoObject 继承。）
	Discover	Discovers a list of type Object. （从 SqlSmoObject 继承。）
	DropImpl	Drops a SqlSmoObject. （从 SqlSmoObject 继承。）
	DropImplWorker	Calls the drop methods. （从 SqlSmoObject 继承。）
	Equals	（从 Object 继承。）
	ExecuteNonQuery	Executes a batch of statements that does not return a result set. （从 SqlSmoObject 继承。）
	ExecuteRenameQuery	Executes the rename query for the object. （从 NamedSmoObject 继承。）
	Finalize	（从 Object 继承。）
	ForceTextModeOnTextBody	Enforces text mode on the text body. （从 ScriptNameObjectBase 继承。）
	FormatSqlVariant	Formats an object as SqlVariant type. （从 SqlSmoObject 继承。）
	GenerateAlterEvent()	Generates the alter event with the specified value. （从 SqlSmoObject 继承。）
	GenerateAlterEvent(Urn, Object)	Generates alter event with the specified URN and inner object value. （从 SqlSmoObject 继承。）
	GetBraketNameForText	Gets the bracket name for the text. （从 ScriptNameObjectBase 继承。）
	GetContextDB	Gets the context database that is associated with this object. （从 SqlSmoObject 继承。）
	GetDBName	Gets the database name that is associated with the object. （从 SqlSmoObject 继承。）
	GetFragOptionString	Gets a FragmentationOption object as a string value. （从 SqlSmoObject 继承。）
	GetHashCode	（从 Object 继承。）
	GetIsSystemNamed	Gets a Boolean value that specifies whether the system is named. （从 ScriptNameObjectBase 继承。）
	GetIsTextDirty	Determines whether the text value is consistent with stored value. （从 ScriptNameObjectBase 继承。）
	GetPropValue	Gets a property value of the SqlSmoObject object. （从 SqlSmoObject 继承。）
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. （从 SqlSmoObject 继承。）
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. （从 SqlSmoObject 继承。）
	GetRealValue	Gets a property value of the SqlSmoObject object. （从 SqlSmoObject 继承。）
	GetServerName	Gets the name of the instance of SQL Server with which the object is associated. （从 SqlSmoObject 继承。）
	GetServerObject	Gets the server of the SqlSmoObject object. （从 SqlSmoObject 继承。）
	GetSqlServerVersionName	Gets the version name of the instance of SQL Server with which the object is associated. （从 SqlSmoObject 继承。）
	GetTextBody()	Returns the text body. （从 ScriptNameObjectBase 继承。）
	GetTextBody(Boolean)	Returns the text body. （从 ScriptNameObjectBase 继承。）
	GetTextHeader	Returns the text header. （从 ScriptNameObjectBase 继承。）
	GetTextMode	Determines whether the script name is using text mode. （从 ScriptNameObjectBase 继承。）
	GetTextProperty	Gets the text of the object, if not available, throw appropriate exception based on the state of the object. （从 ScriptNameObjectBase 继承。）
	GetType	（从 Object 继承。）
	GetUrnRecursive(StringBuilder)	Assigns an Urn object of the SqlSmoObject object. （从 SqlSmoObject 继承。）
	GetUrnRecursive(StringBuilder, UrnIdOption)	Assigns an Urn object of the SqlSmoObject object. （从 SqlSmoObject 继承。）
	ImplInitialize	Initializes the fields of the SqlSmoObject object. （从 SqlSmoObject 继承。）
	Initialize()	Initializes the object and forces the properties be loaded. （从 SqlSmoObject 继承。）
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. （从 SqlSmoObject 继承。）
	IsObjectDirty	Determines whether the referenced object is consistent with the stored object. （从 ScriptNameObjectBase 继承。）
	IsObjectInitialized	Verifies whether the object has been initialized. （从 SqlSmoObject 继承。）
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. （从 SqlSmoObject 继承。）
	isParentClrImplemented	Gets a Boolean which indicates whether the parent object is implemented in CLR. （从 ParameterBase 继承。）
	IsVersion80SP3	Determines whether the version of SQL Server is SQL Server 2000 with SP3. （从 SqlSmoObject 继承。）
	IsVersion90AndAbove	Determines whether the version of SQL Server is SQL Server 2005 or later. （从 SqlSmoObject 继承。）
	MarkDropped	Sets the SqlSmoState to dropped. （从 SqlSmoObject 继承。）
	MarkForDrop	Marks the foreign key to be dropped next time its parent object is altered by the Alter method. （从 ParameterBase 继承。）
	MarkForDropImpl	Sets the SqlSmoState for drop operation. （从 SqlSmoObject 继承。）
	MemberwiseClone	（从 Object 继承。）
	PostAlter	The method that is activated after the SqlSmoObject is altered. （从 SqlSmoObject 继承。）
	PostCreate	The method that is activated after the SqlSmoObject is created. （从 SqlSmoObject 继承。）
	PostDrop	The method that is activated after the SqlSmoObject is dropped. （从 SqlSmoObject 继承。）
	Refresh	Refreshes the ParameterBase object. （从 ParameterBase 继承。）
	RenameImpl	This method supports the SMO infrastructure and is not intended to be used directly from your code. （从 NamedSmoObject 继承。）
	RenameImplWorker	标识为仅供参考。不提供支持。不保证以后的兼容性。（从 NamedSmoObject 继承。）
	ScriptImpl()	Gets a collection of scripts of the SqlSmoObject. （从 SqlSmoObject 继承。）
	ScriptImpl(ScriptingOptions)	Gets a collection of scripts of the SqlSmoObject. （从 SqlSmoObject 继承。）
	SetCollectionTextMode	Sets the collection text mode. （从 ScriptNameObjectBase 继承。）
	SetIsSystemNamed	Sets a Boolean value that specifies whether the system is named. （从 ScriptNameObjectBase 继承。）
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. （从 SqlSmoObject 继承。）
	SetSchemaOwned	Sets the schema owned value. （从 NamedSmoObject 继承。）
	SetTextBody	Specifies the text body. （从 ScriptNameObjectBase 继承。）
	SetTextHeader	Specifies the text header. （从 ScriptNameObjectBase 继承。）
	SetTextMode	Specifies the text mode. （从 ScriptNameObjectBase 继承。）
	SwitchTextMode	Switches the text mode. （从 ScriptNameObjectBase 继承。）
	ThrowIfTextIsDirtyForAlter	Throws an exception of text has been modified and not persisted. （从 ScriptNameObjectBase 继承。）
	ToString	Returns a String that represents the referenced object. （从 SqlSmoObject 继承。）
	TouchImpl	Not implemented. （从 SqlSmoObject 继承。）
	UnbindDefaultImpl	Unbinds the default columns of the SqlSmoObject. （从 SqlSmoObject 继承。）
	UnbindRuleImpl	Unbinds rules of the SqlSmoObject. （从 SqlSmoObject 继承。）
	Validate	Validates the state of an object. （从 SmoObjectBase 继承。）

页首

事件

	名称	说明
	PropertyChanged	Represents the event that occurs when a property is changed. （从 SqlSmoObject 继承。）
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. （从 SqlSmoObject 继承。）

页首

字段

	名称	说明
	m_ExtendedProperties	Represents a property that is defined to extend the properties provided by a SqlSmoObject. （从 SqlSmoObject 继承。）
	singletonParent	Represents the singleton parent. （从 SqlSmoObject 继承。）

页首

显式接口实现

	名称	说明
	IAlienObject.Discover	Discovers any dependencies. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。（从 SqlSmoObject 继承。）
	IAlienObject.GetDomainRoot	Returns the root of the domain. （从 SqlSmoObject 继承。）
	IAlienObject.GetParent	Gets the parent of this object. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。（从 SqlSmoObject 继承。）
	IAlienObject.GetPropertyType	Gets the type of the specified property. （从 SqlSmoObject 继承。）
	IAlienObject.GetPropertyValue	Gets the value of the specified property. （从 SqlSmoObject 继承。）
	IAlienObject.GetUrn	Gets the Unified Resource Name (URN) of the object. 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。（从 SqlSmoObject 继承。）
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. （从 SqlSmoObject 继承。）
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. （从 SqlSmoObject 继承。）
	IAlienObject.SetPropertyValue	Sets the property value. （从 SqlSmoObject 继承。）
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. （从 SqlSmoObject 继承。）
	ISfcSupportsDesignMode.IsDesignMode	Gets a Boolean value that indicates whether the object supports design mode. 标识为仅供参考。不提供支持。不保证以后的兼容性。

页首

注释

Thread Safety

此类型的任何公共静态（Microsoft Visual Basic 中的 Shared）成员在多线程操作中是安全的。但不保证所有实例成员都是线程安全的。

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared）成员都是线程安全的。不保证所有实例成员都是线程安全的。

请参阅

参考

Microsoft.SqlServer.Management.Smo 命名空间

通过