Класс StoredProcedureParameter

The StoredProcedureParameter object represents a SQL Server stored procedure parameter.

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

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

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

Синтаксис

'Декларация
<SfcElementTypeAttribute("Param")> _
Public NotInheritable Class StoredProcedureParameter _
    Inherits Parameter _
    Implements ISfcSupportsDesignMode
'Применение
Dim instance As StoredProcedureParameter

[SfcElementTypeAttribute("Param")]
public sealed class StoredProcedureParameter : Parameter, 
    ISfcSupportsDesignMode

[SfcElementTypeAttribute(L"Param")]
public ref class StoredProcedureParameter sealed : public Parameter, 
    ISfcSupportsDesignMode

[<SealedAttribute>]
[<SfcElementTypeAttribute("Param")>]
type StoredProcedureParameter =  
    class
        inherit Parameter
        interface ISfcSupportsDesignMode
    end

public final class StoredProcedureParameter extends Parameter implements ISfcSupportsDesignMode

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

Конструкторы

	Имя	Описание
	StoredProcedureParameter() () () ()	Initializes a new instance of the StoredProcedureParameter class.
	StoredProcedureParameter(StoredProcedure, String)	Initializes a new instance of the StoredProcedureParameter class for the specified stored procedure and with the specified name.
	StoredProcedureParameter(StoredProcedure, String, DataType)	Initializes a new instance of the StoredProcedureParameter class for the specified stored procedure and with the specified name and data type.

В начало

Свойства

	Имя	Описание
	DataType	Gets or sets the data type associated with the parameter. (Производный от ParameterBase.)
	DefaultValue	Gets or sets the default value of the parameter. (Производный от Parameter.)
	ExecuteForScalar	Возвращает или задает значение свойства типа Boolean, указывающее, настроен ли объект для выполнения в скалярном режиме. (Производный от 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. (Производный от Parameter.)
	IsCursorParameter	Gets or sets the Boolean property that specifies whether the parameter is a cursor parameter.
	IsOutputParameter	Gets or sets the Boolean property that specifies whether the parameter is an output parameter.
	IsReadOnly	Gets or sets a read only condition for a parameter. (Производный от Parameter.)
	IsTouched	Возвращает значение свойства типа Boolean, указывающее, были ли свойства объекта обновлены, но еще не сохранены на сервере. (Производный от SqlSmoObject.)
	Name	Gets or sets a String value that specifies the name of the parameter. (Производный от ParameterBase.)
	ObjectInSpace	Возвращает значение свойства типа Boolean, указывающее, существует ли объект изолированно или же он явно или неявно подключен к экземпляру SQL Server. (Производный от SqlSmoObject.)
	Parent	Gets the StoredProcedure object that is the parent of the StoredProcedureParameter object.
	Properties	Возвращает коллекцию объектов Property, представляющих свойства объекта. (Производный от SqlSmoObject.)
	ScalarResult	Возвращает скалярный результат для объекта, на который ссылаются. (Производный от SqlSmoObject.)
	State	Gets the state of the referenced object. (Производный от SmoObjectBase.)
	Urn	Возвращает значение адреса универсального имени ресурса (URN), которое однозначно идентифицирует объект. (Производный от SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Производный от SmoObjectBase.)

В начало

Методы

	Имя	Описание
	AddDatabaseContext(StringCollection)	Добавляет контекст базы данных в коллекцию запросов, определенную параметром queries. (Производный от SqlSmoObject.)
	AddDatabaseContext(StringCollection, ScriptingOptions)	Добавляет контекст базы данных в коллекцию запросов, определяемую параметром queries при использовании указанных параметров создания скриптов. (Производный от SqlSmoObject.)
	AlterImpl	Активирует событие изменения объекта. (Производный от SqlSmoObject.)
	AlterImplFinish	Метод, вызываемый при завершении события изменения объекта. (Производный от SqlSmoObject.)
	AlterImplInit	Метод, вызываемый при инициализации события изменения объекта. (Производный от SqlSmoObject.)
	AlterImplWorker	Вызывает методы изменения. (Производный от 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	Связывает элементы по умолчанию, определенные параметрами. (Производный от SqlSmoObject.)
	BindRuleImpl	Связывает схему правил с правилом и столбцами, определенными параметрами. (Производный от SqlSmoObject.)
	CheckCollation	Проверяет порядок параметров создания скриптов в методе сортировки, определенном параметром collationName. (Производный от SqlSmoObject.)
	CheckObjectDirty	Checks whether object has been modified and not persisted. (Производный от ScriptNameObjectBase.)
	CheckObjectState() () () ()	Проверяет состояние связанного объекта. (Производный от SqlSmoObject.)
	CheckObjectState(Boolean)	Проверяет состояние связанного объекта с возможностью указать исключение, возникающее, если объект еще не создан. (Производный от SqlSmoObject.)
	CheckObjectStateImpl	Проверяет состояние объекта SqlSmoObject. (Производный от SqlSmoObject.)
	CheckParamName	Checks the parameter name. (Производный от ParameterBase.)
	CheckTextCorectness	Checks text for correctness against the parameters. (Производный от ScriptNameObjectBase.)
	CheckTextModeSupport	Checks mode of support. (Производный от ScriptNameObjectBase.)
	CheckVersion100	Проверяет, является ли SQL Server версией SQL Server 2008. (Производный от SqlSmoObject.)
	CheckVersion80	Проверяет правильность объекта в SQL Server 2000. (Производный от SqlSmoObject.)
	CheckVersion80SP3	Проверяет правильность объекта в SQL Server 2000 с пакетом обновления 3 (SP3). (Производный от SqlSmoObject.)
	CheckVersion90	Проверяет правильность объекта в SQL Server 2005. (Производный от SqlSmoObject.)
	CheckVersionBelow90	Проверяет, является ли SQL Server более ранней версией, чем SQL Server 2005. (Производный от SqlSmoObject.)
	CleanObject	Cleans the referenced object. (Производный от ScriptNameObjectBase.)
	CreateImpl	Создает объект с параметрами создания скриптов. (Производный от SqlSmoObject.)
	CreateImplFinish	Метод, вызываемый при завершении события создания. (Производный от SqlSmoObject.)
	CreateImplInit	Метод, вызываемый при инициализации события создания. (Производный от SqlSmoObject.)
	Discover	Находит список типа Object. (Производный от SqlSmoObject.)
	DropImpl	Удаляет объект SqlSmoObject. (Производный от SqlSmoObject.)
	DropImplWorker	Вызывает методы удаления. (Производный от SqlSmoObject.)
	EnumScriptImpl	Перечисляет сценарии, заданные параметром so. (Производный от SqlSmoObject.)
	EnumScriptImplWorker	Вызывает методы, перечисляющие заданные параметром so сценарии. (Производный от SqlSmoObject.)
	EnumScriptImplWorkerSOChanged	Возвращает строку IEnumerable, описывающую параметры создания скриптов объекта. (Производный от SqlSmoObject.)
	Equals	(Производный от Object.)
	ExecuteNonQuery	(Производный от SqlSmoObject.)
	Finalize	(Производный от Object.)
	ForceTextModeOnTextBody	Enforces text mode on the text body. (Производный от ScriptNameObjectBase.)
	FormatSqlVariant	Форматирует объект как имеющий тип SqlVariant. (Производный от SqlSmoObject.)
	GenerateDataSpaceFileStreamScript	Формирует скрипт, создающий файл данных. (Производный от SqlSmoObject.)
	GenerateDataSpaceScript	Формирует скрипт, выделяющий пространство в файле данных. (Производный от SqlSmoObject.)
	GetBindDefaultScript	Возвращает скрипт, привязывающий значения по умолчанию, определенные параметрами defSchema и defName. (Производный от SqlSmoObject.)
	GetBindRuleScript	Возвращает скрипт, указывающий правила привязки. (Производный от SqlSmoObject.)
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	Назначает параметр типа boolean объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	Назначает свойство типа boolean объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetBraketNameForText	Gets the bracket name. (Производный от ScriptNameObjectBase.)
	GetDateTimeParameter	Назначает свойство типа datetime объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetDateTimeParameterAsInt	Назначает свойство типа datetime объекта SqlSmoObject в виде целочисленного значения, если свойство типа datetime не равно NULL. (Производный от SqlSmoObject.)
	GetDBName	Возвращает имя базы данных, связанной с объектом. (Производный от SqlSmoObject.)
	GetEnumParameter	Назначает свойство перечисления SqlSmoObject. (Производный от SqlSmoObject.)
	GetFragOptionString	Возвращает объект FragmentationOption в виде строкового значения. (Производный от SqlSmoObject.)
	GetGuidParameter	Назначает свойство Guid объекта SqlSmoObject. (Производный от 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.)
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	Назначает параметр объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	Назначает параметр объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetPropValue	Возвращает значение свойства объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetPropValueOptional	Возвращает значение свойства объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetPropValueOptionalAllowNull	Возвращает значение свойства объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetRealValue	Возвращает значение свойства объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetScriptIncludeExists	Gets the script including the test for existence of type being scripted. (Производный от ScriptNameObjectBase.)
	GetScriptingOptionsForCreate	Возвращает параметры ScriptingOptions объектаSqlSmoObject. (Производный от SqlSmoObject.)
	GetServerName	Возвращает имя экземпляра SQL Server, с которым связан объект. (Производный от SqlSmoObject.)
	GetServerObject	Возвращает сервер объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetSqlServerVersionName	Возвращает имя версии экземпляра SQL Server, с которым связан объект. (Производный от SqlSmoObject.)
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	Назначает параметр типа string объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	Назначает параметр типа string объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetTextBody() () () ()	Returns the text body. (Производный от ScriptNameObjectBase.)
	GetTextBody(Boolean)	Returns the text body. (Производный от ScriptNameObjectBase.)
	GetTextForScript(ScriptingOptions, Boolean, array<String> [] () [] [])	Gets the text for scripting. (Производный от ScriptNameObjectBase.)
	GetTextForScript(ScriptingOptions, Boolean, array<String> [] () [] [], Boolean)	Gets the text of script object. (Производный от ScriptNameObjectBase.)
	GetTextHeader	Returns the text header. (Производный от ScriptNameObjectBase.)
	GetTextMode	Determines whether the script name is using text mode. (Производный от ScriptNameObjectBase.)
	GetTextProperty(String)	Gets the property as text. (Производный от ScriptNameObjectBase.)
	GetTextProperty(String, ScriptingOptions)	Gets the property as text. (Производный от ScriptNameObjectBase.)
	GetTimeSpanParameterAsInt	Назначает параметр временного диапазона объекта SqlSmoObject. (Производный от SqlSmoObject.)
	GetType	(Производный от Object.)
	GetUrnRecursive(StringBuilder)	Присваивает объект Urn объекту SqlSmoObject. (Производный от SqlSmoObject.)
	GetUrnRecursive(StringBuilder, UrnIdOption)	Присваивает объект Urn объекту SqlSmoObject. (Производный от SqlSmoObject.)
	ImplInitialize	Инициализирует поля объекта SqlSmoObject. (Производный от SqlSmoObject.)
	Initialize() () () ()	Инициализирует объект и инициирует загрузку свойств. (Производный от SqlSmoObject.)
	Initialize(Boolean)	Инициализирует объект и инициирует загрузку свойств. (Производный от SqlSmoObject.)
	IsObjectDirty	Determines whether the referenced object is consistent with the stored object. (Производный от ScriptNameObjectBase.)
	IsObjectInitialized	Проверяет, был ли объект инициализирован. (Производный от SqlSmoObject.)
	IsObjectInSpace	Проверяет, является ли объект изолированным или подключенным к экземпляру SQL Server. (Производный от SqlSmoObject.)
	IsVersion80SP3	Определяет, является ли SQL Server версией SQL Server 2000 с пакетом обновления 3 (SP3). (Производный от SqlSmoObject.)
	IsVersion90AndAbove	Определяет, является ли SQL Server версией SQL Server 2005 или более поздней. (Производный от SqlSmoObject.)
	MarkDropped	Устанавливает состояние SqlSmoState для удаления. (Производный от SqlSmoObject.)
	MarkForDrop	Marks the foreign key to be dropped next time its parent object is altered by the Alter method. (Производный от ParameterBase.)
	MarkForDropImpl	Устанавливает состояние SqlSmoState для удаления. (Производный от SqlSmoObject.)
	MemberwiseClone	(Производный от Object.)
	PostAlter	Метод, активируемый после изменения SqlSmoObject. (Производный от SqlSmoObject.)
	PostCreate	Метод, активируемый после создания SqlSmoObject. (Производный от SqlSmoObject.)
	PostDrop	Метод, активируемый после удаления SqlSmoObject. (Производный от SqlSmoObject.)
	Refresh	Refreshes the ParameterBase object. (Производный от ParameterBase.)
	RenameImpl	Указано только в ознакомительных целях. Не поддерживается. Совместимость с будущими версиями не гарантируется. (Производный от NamedSmoObject.)
	RenameImplWorker	Указано только в ознакомительных целях. Не поддерживается. Совместимость с будущими версиями не гарантируется. (Производный от NamedSmoObject.)
	ScriptAlter	Изменяет SqlSmoObject в соответствии с параметрами. (Производный от SqlSmoObject.)
	ScriptAnsiQI	Scripts the database object in ANSI text. (Производный от ScriptNameObjectBase.)
	ScriptChangeOwner	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Производный от NamedSmoObject.)
	ScriptCreate	Изменяет SqlSmoObject в соответствии с параметрами. (Производный от SqlSmoObject.)
	ScriptDdl	Builds a DDL script by using specified options from an existing String Collection object. (Производный от ParameterBase.)
	ScriptDrop	Вызывает исключение InvalidSmoOperationException. (Производный от SqlSmoObject.)
	ScriptImpl() () () ()	Возвращает коллекцию скриптов SqlSmoObject. (Производный от SqlSmoObject.)
	ScriptImpl(ScriptingOptions)	Возвращает коллекцию скриптов SqlSmoObject. (Производный от SqlSmoObject.)
	ScriptImplWorker	Возвращает коллекцию скриптов SqlSmoObject. (Производный от SqlSmoObject.)
	ScriptInformativeHeaders	Scripts the information headers. (Производный от ScriptNameObjectBase.)
	ScriptOwner	Alters the script owner authorization. (Производный от NamedSmoObject.)
	ScriptRename	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Производный от NamedSmoObject.)
	SetCollectionTextMode	Sets the collection text mode. (Производный от ScriptNameObjectBase.)
	SetIsSystemNamed	Sets a Boolean value that specifies whether the system is named. (Производный от ScriptNameObjectBase.)
	SetParentImpl	Устанавливает родительский объект объекта SqlSmoObject в значение параметра newParent. (Производный от 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	Возвращает String, представляющее объект, на который ссылаются. (Производный от SqlSmoObject.)
	TouchImpl	Не реализовано. (Производный от SqlSmoObject.)
	UnbindDefaultImpl	Отменяет привязку столбцов по умолчанию для объекта SqlSmoObject. (Производный от SqlSmoObject.)
	UnbindRuleImpl	Отменяет привязку правил для объекта SqlSmoObject. (Производный от SqlSmoObject.)
	Validate	Validates the state of an object. (Производный от SmoObjectBase.)

В начало

События

	Имя	Описание
	PropertyChanged	Представляет событие, возникающее при изменении свойства. (Производный от SqlSmoObject.)
	PropertyMetadataChanged	Представляет событие, возникающее при изменении метаданных свойства. (Производный от SqlSmoObject.)

В начало

Поля

	Имя	Описание
	m_ExtendedProperties	Представляет свойство, определенное для расширения свойств, предоставляемых объектом SqlSmoObject. (Производный от SqlSmoObject.)
	singletonParent	Представляет единственного родителя. (Производный от SqlSmoObject.)

В начало

Явные реализации интерфейса

	Имя	Описание
	IAlienObject. . :: . .Discover	Находит любые зависимости. Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. (Производный от SqlSmoObject.)
	IAlienObject. . :: . .GetDomainRoot	Возвращает корневой элемент домена. (Производный от SqlSmoObject.)
	IAlienObject. . :: . .GetParent	Возвращает родительский объект для данного объекта. Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. (Производный от SqlSmoObject.)
	IAlienObject. . :: . .GetPropertyType	Возвращает тип указанного свойства. (Производный от SqlSmoObject.)
	IAlienObject. . :: . .GetPropertyValue	Возвращает значение указанного свойства. (Производный от SqlSmoObject.)
	IAlienObject. . :: . .GetUrn	Возвращает универсальное имя ресурса для объекта. Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. (Производный от SqlSmoObject.)
	IAlienObject. . :: . .Resolve	Возвращает экземпляр, содержащий данные об объекте из универсального имени ресурса для объекта. (Производный от SqlSmoObject.)
	IAlienObject. . :: . .SetObjectState	Задает состоянию объекта указанное значение SfcObjectState. (Производный от SqlSmoObject.)
	IAlienObject. . :: . .SetPropertyValue	Устанавливает значение свойства. (Производный от SqlSmoObject.)
	ISfcPropertyProvider. . :: . .GetPropertySet	Возвращает ссылку на интерфейс для набора свойств данного объекта. Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. (Производный от SqlSmoObject.)
	ISfcSupportsDesignMode. . :: . .IsDesignMode	Gets a value that indicates whether the StoredProcedureParameter object supports design mode.

В начало

Замечания

To get StoredProcedureParameter object properties, users can be a member of the public fixed server role.

To set StoredProcedureParameter object properties, users must have ALTER permission on the parent stored procedure, or be a member of db_owner fixed database role.

To create a stored procedure, users must have CREATE PROCEDURE permission on the parent database or be a member of the db_owner fixed database role.

To drop a stored procedure parameter, users must have CONTROL permission on the parent stored procedure or be a member of the db_owner fixed database role.

Thread Safety

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

Примеры

Создание, изменение и удаление хранимых процедур

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

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

См. также

Справочник

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