StoredProcedure Class

 

The StoredProcedure object represents a SQL Server stored procedure.

Namespace:   Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)


[PhysicalFacetAttribute(PhysicalFacetOptions::ReadOnly)]
[StateChangeEventAttribute("CREATE_PROCEDURE", "PROCEDURE")]
[StateChangeEventAttribute("ALTER_PROCEDURE", "PROCEDURE")]
[StateChangeEventAttribute("RENAME", "PROCEDURE")]
[StateChangeEventAttribute("ALTER_AUTHORIZATION_DATABASE", "PROCEDURE")]
[StateChangeEventAttribute("ALTER_SCHEMA", "PROCEDURE")]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::None | AutomatedPolicyEvaluationMode::Enforce | AutomatedPolicyEvaluationMode::CheckOnChanges | AutomatedPolicyEvaluationMode::CheckOnSchedule)]
public ref class StoredProcedure sealed : ScriptSchemaObjectBase, 
	ISfcSupportsDesignMode, IObjectPermission, ICreatable, IAlterable, 
	IDroppable, IDropIfExists, IRenamable, IExtendedProperties, 
	IScriptable, ITextObject

NameDescription
System_CAPS_pubmethodStoredProcedure()

Initializes a new instance of the StoredProcedure class.

System_CAPS_pubmethodStoredProcedure(Database^, String^)

Initializes a new instance of the StoredProcedure class on the specified database and with the specified name.

System_CAPS_pubmethodStoredProcedure(Database^, String^, String^)

Initializes a new instance of the StoredProcedure class on the specified database and with the specified name and schema.

NameDescription
System_CAPS_pubpropertyAnsiNullsStatus

Gets the Boolean property value that specifies whether ISO NULL handling is enabled in the stored procedure.

System_CAPS_pubpropertyAssemblyName

Gets or sets the name of the .NET assembly that is required by the referenced stored procedure.

System_CAPS_pubpropertyClassName

Gets or sets the name of the class called by the referenced stored procedure.

System_CAPS_pubpropertyCreateDate

Gets the date and time when the stored procedure was created.

System_CAPS_pubpropertyDateLastModified

Gets the date and time when the stored procedure was last modified.

System_CAPS_pubpropertyEvents

Gets the events associated with the stored procedure.

System_CAPS_pubpropertyExecutionContext

Gets or sets the execution context for the stored procedure.

System_CAPS_pubpropertyExecutionContextPrincipal

Gets or sets the execution context principal for the stored procedure.

System_CAPS_pubpropertyExecutionManager

Gets the object to execute to the manager.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyExtendedProperties

Gets the extended properties of the StoredProcedure object.

System_CAPS_pubpropertyForReplication

Gets or sets the Boolean property value that specifies whether the stored procedure is available for replication.

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the stored procedure.

System_CAPS_pubpropertyImplementationType

Gets or sets the implementation type of the stored procedure.

System_CAPS_pubpropertyIsEncrypted

Gets or sets the Boolean property value that specifies whether the stored procedure is encrypted.

System_CAPS_pubpropertyIsNativelyCompiled

Gets or sets the Boolean property that specifies whether the stored procedure is natively compiled.

System_CAPS_pubpropertyIsSchemaBound

Gets or sets the Boolean property that specifies whether the stored procedure is bound to the schema of the database objects it references.

System_CAPS_pubpropertyIsSchemaOwned

Gets a Boolean property that specifies whether the stored procedure is owned by a schema.

System_CAPS_pubpropertyIsSystemObject

Gets the Boolean property value that specifies whether the stored procedure is a system object.

System_CAPS_pubpropertyMethodName

Gets the method name for the stored procedure.

System_CAPS_pubpropertyName

Gets or sets a String value that specifies the name of the stored procedure.(Overrides ScriptSchemaObjectBase::Name.)

System_CAPS_pubpropertyNumberedStoredProcedures

Represents a collection of NumberedStoredProcedureCollection objects. Each NumberedStoredProcedure object represents a numbered stored procedure defined for the stored procedure.

System_CAPS_pubpropertyOwner

Gets or sets the owner of the stored procedure.

System_CAPS_pubpropertyParameters

Represents a collection of StoredProcedureParameterCollection objects. Each StoredProcedureParameter object represents a parameter defined for the stored procedure.

System_CAPS_pubpropertyParent

Gets or sets the Database object that is the parent of the StoredProcedure object.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyQuotedIdentifierStatus

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.

System_CAPS_pubpropertyRecompile

Gets or sets the Boolean property value that specifies whether the stored procedure is recompiled before execution.

System_CAPS_pubpropertySchema

Gets or sets a String value that specifies the name of the schema that contains the stored procedure.(Overrides ScriptSchemaObjectBase::Schema.)

System_CAPS_pubpropertyStartup

Gets or sets the Boolean property value that specifies whether the stored procedure runs when the instance of Microsoft SQL Server starts up.

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyTextBody

Gets or sets the Transact-SQL string that defines the stored procedure.

System_CAPS_pubpropertyTextHeader

Gets or sets the header part of the Transact-SQL string that defines the stored procedure.

System_CAPS_pubpropertyTextMode

Gets or sets the Boolean property that specifies whether the text header is editable as text.

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubmethodAlter()

Updates any StoredProcedure object property changes on the instance of Microsoft SQL Server. 

System_CAPS_pubmethodChangeSchema(String^)

Changes the schema for the stored procedure.

System_CAPS_pubmethodCreate()

Creates a stored procedure on the instance of Microsoft SQL Server as defined by the StoredProcedure object.

System_CAPS_pubmethodDeny(ObjectPermissionSet^, String^)

Denies the specified set of permissions for the specified grantee on the stored procedure.

System_CAPS_pubmethodDeny(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.

System_CAPS_pubmethodDeny(ObjectPermissionSet^, array<String^>^)

Denies the specified set of permissions for the specified grantees on the stored procedure.

System_CAPS_pubmethodDeny(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.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Removes the stored procedure from the instance of SQL Server.

System_CAPS_pubmethodDropIfExists()

Drops the StoredProcedure object if exists.

System_CAPS_pubmethodEnumObjectPermissions()

Enumerates a list of object permissions for the stored procedure.

System_CAPS_pubmethodEnumObjectPermissions(ObjectPermissionSet^)

Enumerates a list of object permissions for a specified permission on the stored procedure.

System_CAPS_pubmethodEnumObjectPermissions(String^)

Enumerates a list of object permissions for a specified grantee on the stored procedure.

System_CAPS_pubmethodEnumObjectPermissions(String^, ObjectPermissionSet^)

Enumerates a list of object permissions for a specified grantee and a specified permission on the stored procedure.

System_CAPS_pubmethodEquals(Object^)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object^)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String^)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String^)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String^)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGrant(ObjectPermissionSet^, String^)

Grants the specified set of permissions to the specified grantee on the stored procedure.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(ObjectPermissionSet^, array<String^>^)

Grants the specified set of permissions to the specified grantees on the stored procedure.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodGrant(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.

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodIsSupportedProperty(String^)

Determines whether the specified property is supported in the target .NET Framework.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodReCompileReferences()

Recompiles any stored procedure or trigger that depends on the base SMO object.

System_CAPS_pubmethodRefresh()

Refreshes the script name.(Inherited from ScriptNameObjectBase.)

System_CAPS_pubmethodRename(String^)

Renames the stored procedure.

System_CAPS_pubmethodRevoke(ObjectPermissionSet^, String^)

Revokes a previously granted set of permissions from a grantee on the stored procedure.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(ObjectPermissionSet^, array<String^>^)

Revokes a previously granted set of permissions from a list of grantees on the stored procedure.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodRevoke(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.

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the stored procedure.

System_CAPS_pubmethodScript(ScriptingOptions^)

Generates a Transact-SQL script that can be used to re-create the stored procedure as specified by the script options.

System_CAPS_pubmethodScriptHeader(Boolean)

Returns the text header with the option to modify the text.

System_CAPS_protmethodSetParentImpl(SqlSmoObject^)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String^, array<Object^>^)

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetParent()

Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetPropertyType(String^)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetPropertyValue(String^, Type^)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::GetUrn()

Gets the Unified Resource Name (URN) of the object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::Resolve(String^)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject::SetPropertyValue(String^, Type^, Object^)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider::GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyISfcSupportsDesignMode::IsDesignMode

Gets a value that indicates whether the stored procedure supports design mode.

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

To set StoredProcedure object properties, users must have ALTER permission on the 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, users must have CONTROL permission on the stored procedure or be a member of the db_owner fixed database role.

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: