Класс ParameterBase

The ParameterBase class is a base class that is inherited by the Parameter class and the UserDefinedAggregate class. It contains common features of both classes.

Иерархия наследования

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.ParameterBase
            Microsoft.SqlServer.Management.Smo.Parameter
            Microsoft.SqlServer.Management.Smo.UserDefinedAggregateParameter

Пространство имен:  Microsoft.SqlServer.Management.Smo
Сборка:  Microsoft.SqlServer.Smo (в Microsoft.SqlServer.Smo.dll)

Синтаксис

'Декларация
Public Class ParameterBase _
    Inherits ScriptNameObjectBase _
    Implements IExtendedProperties, IMarkForDrop
'Применение
Dim instance As ParameterBase

public class ParameterBase : ScriptNameObjectBase, 
    IExtendedProperties, IMarkForDrop

public ref class ParameterBase : public ScriptNameObjectBase, 
    IExtendedProperties, IMarkForDrop

type ParameterBase =  
    class 
        inherit ScriptNameObjectBase 
        interface IExtendedProperties 
        interface IMarkForDrop 
    end

public class ParameterBase extends ScriptNameObjectBase implements IExtendedProperties, IMarkForDrop

Тип ParameterBase обеспечивает доступ к следующим элементам.

Свойства

	Имя	Описание
	DataType	Gets or sets the data type associated with 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.
	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. (Переопределяет NamedSmoObject.Name.)
	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.
	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.
	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.
	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. (Переопределяет ScriptNameObjectBase.Refresh().)
	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.)

В начало

Замечания

Thread Safety

Все общие статические члены этого типа (Shared в Microsoft Visual Basic) можно использовать в многопоточных операциях. Потокобезопасная работа с членами экземпляров типа не гарантируется.

Безопасность многопоточности

Любые открытые статический (Shared в Visual Basic) элементы этого типа потокобезопасны. Потокобезопасность с элементами экземпляров не гарантируется.

См. также

Справочник

Пространство имен Microsoft.SqlServer.Management.Smo