StoredProcedure Members

Include Protected Members
Include Inherited Members

The StoredProcedure object represents a SQL Server stored procedure.

The StoredProcedure type exposes the following members.

Constructors

	Name	Description
	StoredProcedure()	Initializes a new instance of the StoredProcedure class.
	StoredProcedure(Database, String)	Initializes a new instance of the StoredProcedure class on the specified database and with the specified name.
	StoredProcedure(Database, String, String)	Initializes a new instance of the StoredProcedure class on the specified database and with the specified name and schema.

Top

Methods

	Name	Description
	AddDatabaseContext(StringCollection)	(Inherited from SqlSmoObject.)
	Alter()	Updates any StoredProcedure object property changes on the instance of Microsoft SQL Server.
	AlterImpl()	(Inherited from SqlSmoObject.)
	AlterImplFinish(StringCollection, ScriptingOptions)	(Inherited from SqlSmoObject.)
	AlterImplInit(StringCollection%, ScriptingOptions%)	(Inherited from SqlSmoObject.)
	AlterImplWorker()	(Inherited from SqlSmoObject.)
	AppendCommaText(StringBuilder, String, Boolean%, String)	(Inherited from ScriptNameObjectBase.)
	AppendWithCommaText(StringBuilder, String, Boolean%)	(Inherited from ScriptNameObjectBase.)
	AppendWithOption(StringBuilder, String, String, Boolean%)	(Inherited from ScriptNameObjectBase.)
	BindDefaultImpl(String, String, Boolean)	(Inherited from SqlSmoObject.)
	BindRuleImpl(String, String, Boolean)	(Inherited from SqlSmoObject.)
	ChangeSchema(String)	Changes the schema for the stored procedure.
	CheckCollation(String, ScriptingOptions)	(Inherited from SqlSmoObject.)
	CheckObjectDirty()	(Inherited from ScriptNameObjectBase.)
	CheckObjectState()	Validates the state of the referenced object. (Inherited from 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. (Inherited from SqlSmoObject.)
	CheckObjectStateImpl(Boolean)	(Inherited from SqlSmoObject.)
	CheckTextCorectness(String, Boolean, Boolean, array<String[], DdlTextParserHeaderInfo%)	(Inherited from ScriptNameObjectBase.)
	CheckTextModeSupport()	(Inherited from ScriptNameObjectBase.)
	CheckVersion100()	(Inherited from SqlSmoObject.)
	CheckVersion80()	Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
	CheckVersion80SP3()	Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
	CheckVersion90()	Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
	CheckVersionBelow90()	(Inherited from SqlSmoObject.)
	CleanObject()	Cleans the referenced object. (Inherited from ScriptNameObjectBase.)
	Create()	Creates a stored procedure on the instance of Microsoft SQL Server as defined by the StoredProcedure object.
	CreateImpl()	(Inherited from SqlSmoObject.)
	CreateImplFinish(StringCollection, ScriptingOptions)	(Inherited from SqlSmoObject.)
	CreateImplInit(StringCollection%, ScriptingOptions%)	(Inherited from SqlSmoObject.)
	Deny(ObjectPermissionSet, String)	Denies the specified set of permissions for the specified grantee on the stored procedure.
	Deny(ObjectPermissionSet, array<String[])	Denies the specified set of permissions for the specified grantees on the stored procedure.
	Deny(ObjectPermissionSet, String, Boolean)	Denies the specified set of permissions for the specified grantee and other users that the grantee granted the specified set of permissions on the stored procedure.
	Deny(ObjectPermissionSet, array<String[], Boolean)	Denies the specified set of permissions for the specified grantees and other users that the grantee granted the specified set of permissions on the stored procedure.
	Discover()	(Inherited from SqlSmoObject.)
	Drop()	Removes the stored procedure from the instance of SQL Server.
	DropImpl()	(Inherited from SqlSmoObject.)
	DropImplWorker(Urn%)	(Inherited from SqlSmoObject.)
	EnumObjectPermissions()	Enumerates a list of object permissions for the stored procedure.
	EnumObjectPermissions(String)	Enumerates a list of object permissions for a specified grantee on the stored procedure.
	EnumObjectPermissions(ObjectPermissionSet)	Enumerates a list of object permissions for a specified permission on the stored procedure.
	EnumObjectPermissions(String, ObjectPermissionSet)	Enumerates a list of object permissions for a specified grantee and a specified permission on the stored procedure.
	EnumScriptImpl(ScriptingOptions)	(Inherited from SqlSmoObject.)
	EnumScriptImplWorker(ScriptingOptions)	(Inherited from SqlSmoObject.)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	ForceTextModeOnTextBody()	Enforces text mode on the text body. (Inherited from ScriptNameObjectBase.)
	FormatSqlVariant(Object)	(Inherited from SqlSmoObject.)
	GenerateDataSpaceFileStreamScript(StringBuilder, ScriptingOptions, Boolean)	(Inherited from SqlSmoObject.)
	GenerateDataSpaceScript(StringBuilder, ScriptingOptions)	(Inherited from SqlSmoObject.)
	GetBindDefaultScript(ScriptingOptions, String, String, Boolean)	(Inherited from SqlSmoObject.)
	GetBindRuleScript(ScriptingOptions, String, String, Boolean)	(Inherited from SqlSmoObject.)
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	(Inherited from SqlSmoObject.)
	GetBraketNameForText()	(Inherited from ScriptNameObjectBase.)
	GetDateTimeParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetDateTimeParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetDBName()	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetEnumParameter(StringBuilder, ScriptingOptions, String, String, Type, Int32%)	(Inherited from SqlSmoObject.)
	GetFragOptionString(FragmentationOption)	(Inherited from SqlSmoObject.)
	GetGuidParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetHashCode()	(Inherited from Object.)
	GetIsTextDirty()	Determines whether the text value is consistent with stored value. (Inherited from ScriptNameObjectBase.)
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	(Inherited from SqlSmoObject.)
	GetPropValue(String)	(Inherited from SqlSmoObject.)
	GetPropValueOptional(String)	(Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull(String)	(Inherited from SqlSmoObject.)
	GetRealValue(Property, Object)	(Inherited from SqlSmoObject.)
	GetScriptIncludeExists(ScriptingOptions, String, Boolean)	(Inherited from ScriptNameObjectBase.)
	GetScriptingOptionsForCreate()	(Inherited from SqlSmoObject.)
	GetServerName()	Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
	GetServerObject()	(Inherited from SqlSmoObject.)
	GetSqlServerVersionName()	Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	(Inherited from SqlSmoObject.)
	GetTextBody()	Returns the text body. (Inherited from ScriptNameObjectBase.)
	GetTextBody(Boolean)	Returns the text body. (Inherited from ScriptNameObjectBase.)
	GetTextForScript(ScriptingOptions, Boolean, array<String[])	Gets the text for scripting. (Inherited from ScriptNameObjectBase.)
	GetTextForScript(ScriptingOptions, Boolean, array<String[], Boolean)	(Inherited from ScriptNameObjectBase.)
	GetTextHeader(Boolean)	Returns the text header. (Inherited from ScriptNameObjectBase.)
	GetTextMode()	Determines whether the script name is using text mode. (Inherited from ScriptNameObjectBase.)
	GetTextProperty(String)	(Inherited from ScriptNameObjectBase.)
	GetTextProperty(String, ScriptingOptions)	(Inherited from ScriptNameObjectBase.)
	GetTimeSpanParameterAsInt(StringBuilder, ScriptingOptions, String, String, Int32%)	(Inherited from SqlSmoObject.)
	GetType()	(Inherited from Object.)
	GetUrnRecursive(StringBuilder)	(Inherited from SqlSmoObject.)
	GetUrnRecursive(StringBuilder, UrnIdOption)	(Inherited from SqlSmoObject.)
	Grant(ObjectPermissionSet, String)	Grants the specified set of permissions to the specified grantee on the stored procedure.
	Grant(ObjectPermissionSet, array<String[])	Grants the specified set of permissions to the specified grantees on the stored procedure.
	Grant(ObjectPermissionSet, String, Boolean)	Grants access to the specified permission to the grantee and the ability to grant access to other users on the stored procedure.
	Grant(ObjectPermissionSet, array<String[], Boolean)	Grants access to the specified permission to the grantees and the ability to grant access to other users on the stored procedure.
	Grant(ObjectPermissionSet, String, Boolean, String)	Grants the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the stored procedure under an assumed role.
	Grant(ObjectPermissionSet, array<String[], Boolean, String)	Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the stored procedure under an assumed role.
	ImplInitialize(array<String[], array<OrderBy[])	(Inherited from SqlSmoObject.)
	Initialize()	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	IsObjectDirty()	Determines whether the referenced object is consistent with the stored object. (Inherited from ScriptNameObjectBase.)
	IsObjectInitialized()	Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
	IsObjectInSpace()	Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	IsVersion80SP3()	(Inherited from SqlSmoObject.)
	MarkDropped()	(Inherited from SqlSmoObject.)
	MarkForDropImpl(Boolean)	(Inherited from SqlSmoObject.)
	MemberwiseClone()	(Inherited from Object.)
	PostAlter()	(Inherited from SqlSmoObject.)
	PostCreate()	(Inherited from SqlSmoObject.)
	PostDrop()	(Inherited from SqlSmoObject.)
	ReCompileReferences()
	Refresh()	Refreshes the script name. (Inherited from ScriptNameObjectBase.)
	Rename(String)	Renames the stored procedure.
	RenameImpl(String)	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
	RenameImplWorker(String)	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
	Revoke(ObjectPermissionSet, String)	Revokes a previously granted set of permissions from a grantee on the stored procedure.
	Revoke(ObjectPermissionSet, array<String[])	Revokes a previously granted set of permissions from a list of grantees on the stored procedure.
	Revoke(ObjectPermissionSet, String, Boolean, Boolean)	Revokes previously granted permissions from a grantee on the stored procedure and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean)	Revokes previously granted permissions from grantees on the stored procedure and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Revoke(ObjectPermissionSet, String, Boolean, Boolean, String)	Revokes previously granted permissions from a grantee on the stored procedure and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean, String)	Revokes previously granted permissions from grantees on the stored procedure and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Script()	Generates a Transact-SQL script that can be used to re-create the stored procedure.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the stored procedure as specified by the script options.
	ScriptAlter(StringCollection, ScriptingOptions)	(Inherited from SqlSmoObject.)
	ScriptAnsiQI(SqlSmoObject, ScriptingOptions, StringCollection, StringBuilder, Object%, Object%)	(Inherited from ScriptNameObjectBase.)
	ScriptChangeOwner(StringCollection, ScriptingOptions)	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
	ScriptCreate(StringCollection, ScriptingOptions)	(Inherited from SqlSmoObject.)
	ScriptDdl(StringCollection, ScriptingOptions)	(Inherited from SqlSmoObject.)
	ScriptDrop(StringCollection, ScriptingOptions)	(Inherited from SqlSmoObject.)
	ScriptHeader(Boolean)	Returns the text header with the option to modify the text.
	ScriptImpl()	(Inherited from SqlSmoObject.)
	ScriptImpl(ScriptingOptions)	(Inherited from SqlSmoObject.)
	ScriptImplWorker(ScriptingOptions)	(Inherited from SqlSmoObject.)
	ScriptInformativeHeaders(ScriptingOptions, StringBuilder)	(Inherited from ScriptNameObjectBase.)
	ScriptRename(StringCollection, ScriptingOptions, String)	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
	SetCollectionTextMode(Boolean, SmoCollectionBase)	Sets the collection text mode. (Inherited from ScriptNameObjectBase.)
	SetParentImpl(SqlSmoObject)	(Inherited from SqlSmoObject.)
	SetTextBody(String)	Specifies the text body. (Inherited from ScriptNameObjectBase.)
	SetTextHeader(String)	Specifies the text header. (Inherited from ScriptNameObjectBase.)
	SetTextMode(Boolean, array<SmoCollectionBase[])	Specifies the text mode. (Inherited from ScriptNameObjectBase.)
	SwitchTextMode(Boolean, array<SmoCollectionBase[])	Switches the text mode. (Inherited from ScriptNameObjectBase.)
	ThrowIfTextIsDirtyForAlter()	(Inherited from ScriptNameObjectBase.)
	ToString()	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	TouchImpl()	(Inherited from SqlSmoObject.)
	UnbindDefaultImpl(Boolean)	(Inherited from SqlSmoObject.)
	UnbindRuleImpl(Boolean)	(Inherited from SqlSmoObject.)
	Validate(String, array<Object[])	(Inherited from SmoObjectBase.)

Top

Fields

	Name	Description
	m_ExtendedProperties	(Inherited from SqlSmoObject.)

Top

Properties

	Name	Description
	AnsiNullsStatus	Gets the Boolean property value that specifies whether ISO NULL handling is enabled in the stored procedure.
	AssemblyName	Gets or sets the name of the .NET assembly that is required by the referenced stored procedure.
	ClassName	Gets or sets the name of the class called by the referenced stored procedure.
	CreateDate	Gets the date and time when the stored procedure was created.
	DateLastModified	Gets the date and time when the stored procedure was last modified.
	Events	Gets the events associated with the stored procedure.
	ExecuteForScalar	Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.)
	ExecutionContext	Gets or sets the execution context for the stored procedure.
	ExecutionContextPrincipal	Gets or sets the execution context principal for the stored procedure.
	ExtendedProperties	Gets the extended properties of the StoredProcedure object.
	ForReplication	Gets or sets the Boolean property value that specifies whether the stored procedure is available for replication.
	ID	Gets the ID value that uniquely identifies the stored procedure.
	ImplementationType	Gets or sets the implementation type of the stored procedure.
	IsEncrypted	Gets or sets the Boolean property value that specifies whether the stored procedure is encrypted.
	IsSchemaOwned
	IsSystemObject	Gets the Boolean property value that specifies whether the stored procedure is a system object.
	IsTouched	Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.)
	MethodName	Gets the method name for the stored procedure.
	Name	Gets or sets the name of the Schema Object Base. (Inherited from ScriptSchemaObjectBase.)
	NumberedStoredProcedures	Represents a collection of NumberedStoredProcedureCollection objects. Each NumberedStoredProcedure object represents a numbered stored procedure defined for the stored procedure.
	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. (Inherited from SqlSmoObject.)
	Owner
	Parameters	Represents a collection of StoredProcedureParameterCollection objects. Each StoredProcedureParameter object represents a parameter defined for the stored procedure.
	Parent	Gets or sets the Database object that is the parent of the StoredProcedure object.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	QuotedIdentifierStatus	Gets or sets a Boolean property value that specifies whether identifiers delimited by double quotation marks are Transact-SQL reserved keywords or contain characters not usually allowed by the Transact-SQL syntax rules.
	Recompile	Gets or sets the Boolean property value that specifies whether the stored procedure is recompiled before execution.
	ScalarResult	Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
	Schema	Gets or sets the schema. (Inherited from ScriptSchemaObjectBase.)
	Startup	Gets or sets the Boolean property value that specifies whether the stored procedure runs when the instance of Microsoft SQL Server starts up.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	TextBody	Gets or sets the Transact-SQL string that defines the stored procedure.
	TextHeader	Gets or sets the header part of the Transact-SQL string that defines the stored procedure.
	TextMode	Gets or sets the Boolean property that specifies whether the text header is editable as text.
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Events

	Name	Description
	PropertyChanged	(Inherited from SqlSmoObject.)
	PropertyMetadataChanged	(Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

	Name	Description
	IAlienObjectDiscover()	(Inherited from SqlSmoObject.)
	IAlienObjectGetParent()	(Inherited from SqlSmoObject.)
	IAlienObjectGetProperty(String)	(Inherited from SqlSmoObject.)
	ISfcPropertyProviderGetPropertySet()	(Inherited from SqlSmoObject.)
	IAlienObjectGetUrn()	(Inherited from SqlSmoObject.)
	IAlienObjectResolve(String)	(Inherited from SqlSmoObject.)
	IAlienObjectSetProperty(Object, Object)	(Inherited from SqlSmoObject.)

Top

See Also

Reference

StoredProcedure Class

Microsoft.SqlServer.Management.Smo Namespace