NumberedStoredProcedure Class

The NumberedStoredProcedure class represents a Microsoft SQL Server numbered stored procedure.

Inheritance Hierarchy

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.NumberedStoredProcedure

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

Syntax

'Declaration
<SfcElementTypeAttribute("Numbered")> _
Public NotInheritable Class NumberedStoredProcedure _
    Inherits ScriptNameObjectBase _
    Implements ISfcSupportsDesignMode, ICreatable, IAlterable, ITextObject
'Usage
Dim instance As NumberedStoredProcedure

[SfcElementTypeAttribute("Numbered")]
public sealed class NumberedStoredProcedure : ScriptNameObjectBase, 
    ISfcSupportsDesignMode, ICreatable, IAlterable, ITextObject

[SfcElementTypeAttribute(L"Numbered")]
public ref class NumberedStoredProcedure sealed : public ScriptNameObjectBase, 
    ISfcSupportsDesignMode, ICreatable, IAlterable, ITextObject

[<SealedAttribute>]
[<SfcElementTypeAttribute("Numbered")>]
type NumberedStoredProcedure =  
    class 
        inherit ScriptNameObjectBase 
        interface ISfcSupportsDesignMode 
        interface ICreatable 
        interface IAlterable 
        interface ITextObject 
    end

public final class NumberedStoredProcedure extends ScriptNameObjectBase implements ISfcSupportsDesignMode, ICreatable, IAlterable, ITextObject

The NumberedStoredProcedure type exposes the following members.

Constructors

	Name	Description
	NumberedStoredProcedure	Initializes a new instance of the NumberedStoredProcedure class.

Top

Properties

	Name	Description
	IsEncrypted	Gets or sets the Boolean property value that specifies whether the numbered stored procedure is encrypted.
	Name	Gets or sets the name of the numbered stored procedure. (Overrides NamedSmoObject.Name.)
	Number	Gets or sets the number associated with the numbered stored procedure.
	Parameters	Represents a collection of NumberedStoredProcedureParameter objects. Each NumberedStoredProcedureParameter object represents a parameter defined for the numbered stored procedure.
	Parent	Gets or sets the Database object that is the parent of the NumberedStoredProcedure object.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	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

Methods

	Name	Description
	Alter	Updates any NumberedStoredProcedure object property changes on the instance of Microsoft SQL Server.
	Create	Creates a stored procedure on the instance of Microsoft SQL Server as defined by the NumberedStoredProcedure object.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	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.)
	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.)
	Refresh	Refreshes the script name. (Inherited from ScriptNameObjectBase.)
	ScriptHeader	Returns the text header with the option to modify the text.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	ToString	Returns the referenced object as a String value. (Overrides SqlSmoObject.ToString().)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

	Name	Description
	PropertyChanged	Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

	Name	Description
	IAlienObject.Discover	Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Inherited from SqlSmoObject.)
	IAlienObject.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.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.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.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
	ISfcSupportsDesignMode.IsDesignMode	Gets a Boolean value that indicates whether the object supports design mode. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

Top

Remarks

The NumberedStoredProcedure object allows programmatic management of the SQL Server numbered stored procedures.

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

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

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

Thread Safety

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.

Examples

Creating, Altering, and Removing Stored Procedures

Thread Safety

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

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

CREATE PROCEDURE (Transact-SQL)