ExtendedStoredProcedure Class

  • Article

The ExtendedStoredProcedure object represents an extended stored procedure on the instance of Microsoft SQL Server.

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.ScriptSchemaObjectBase
            Microsoft.SqlServer.Management.Smo.ExtendedStoredProcedure

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

Syntax

'Declaration
Public NotInheritable Class ExtendedStoredProcedure _
    Inherits ScriptSchemaObjectBase _
    Implements IObjectPermission, ICreatable, IAlterable, IDroppable,  _
    IExtendedProperties
'Usage
Dim instance As ExtendedStoredProcedure

public sealed class ExtendedStoredProcedure : ScriptSchemaObjectBase, 
    IObjectPermission, ICreatable, IAlterable, IDroppable, IExtendedProperties

public ref class ExtendedStoredProcedure sealed : public ScriptSchemaObjectBase, 
    IObjectPermission, ICreatable, IAlterable, IDroppable, IExtendedProperties

[<SealedAttribute>]
type ExtendedStoredProcedure =  
    class 
        inherit ScriptSchemaObjectBase 
        interface IObjectPermission 
        interface ICreatable 
        interface IAlterable 
        interface IDroppable 
        interface IExtendedProperties 
    end

public final class ExtendedStoredProcedure extends ScriptSchemaObjectBase implements IObjectPermission, ICreatable, IAlterable, IDroppable, IExtendedProperties

The ExtendedStoredProcedure type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property CreateDate Gets the date and time when the extended stored procedure was created.
Public property DateLastModified Gets the date and time when the extended stored procedure was last modified.
Public property DllLocation Gets or sets the directory path for the dynamic link library that contains the external, user-defined routine.
Public property ExtendedProperties Gets the extended properties of the extended stored procedure.
Public property ID Gets the system ID value that uniquely identifies the extended stored procedure.
Public property IsSchemaOwned Gets the Boolean property value that specifies whether the extended stored procedure is owned by a schema.
Public property IsSystemObject Gets the Boolean property value that specifies whether the extended stored procedure is a system object or not.
Public property Name Gets or sets the name of the schema. (Inherited from ScriptSchemaObjectBase.)
Public property Owner Gets or sets the owner of the extended stored procedure.
Public property Parent Gets or sets the Database object that is the parent of the ExtendedStoredProcedure object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property Schema Gets or sets the schema. (Inherited from ScriptSchemaObjectBase.)
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Public method Alter Updates the extended stored procedure on the instance of SQL Server with any property changes that have been made to the ExtendedStoredProcedure object that it represents. 
Public method ChangeSchema Changes the schema associated with the stored procedure.
Public method Create Creates an extended stored procedure on the instance of SQL Server as defined by the ExtendedStoredProcedure object.
Public method Deny(ObjectPermissionSet, String) Denies the specified set of permissions for the specified grantee on the extended stored procedure.
Public method Deny(ObjectPermissionSet, array<String[]) Denies the specified set of permissions for the specified grantees on the extended stored procedure.
Public method 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 extended stored procedure.
Public method 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 extended stored procedure.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Drops the extended stored procedure that is represented by the ExtendedStoredProcedure object.
Public method EnumObjectPermissions() Enumerates a list of permissions for the extended stored procedure.
Public method EnumObjectPermissions(String) Enumerates a list of permissions for the extended stored procedure that belongs to the specified user.
Public method EnumObjectPermissions(ObjectPermissionSet) Enumerates a list of permissions for the extended stored procedure limited to the specified permission set.
Public method EnumObjectPermissions(String, ObjectPermissionSet) Enumerates a list of permissions for the extended stored procedure that belong to the specified user and limited to the specified permission set.
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Grant(ObjectPermissionSet, String) Grants the specified set of permissions to the specified grantee on the extended stored procedure.
Public method Grant(ObjectPermissionSet, array<String[]) Grants the specified set of permissions to the specified grantees on the extended stored procedure.
Public method Grant(ObjectPermissionSet, String, Boolean) Grants access to the specified permission to the grantee and the ability to grant access to other users on the extended stored procedure.
Public method 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 extended stored procedure.
Public method 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 extended stored procedure under an assumed role.
Public method 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 extended stored procedure under an assumed role.
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method Refresh Refreshes the script name. (Inherited from ScriptNameObjectBase.)
Public method Revoke(ObjectPermissionSet, String) Revokes a previously granted set of permissions from a grantee on the extended stored procedure.
Public method Revoke(ObjectPermissionSet, array<String[]) Revokes a previously granted set of permissions from a list of grantees on the extended stored procedure.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean) Revokes previously granted permissions from a grantee on the extended 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.
Public method Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean) Revokes previously granted permissions from grantees on the extended 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.
Public method Revoke(ObjectPermissionSet, String, Boolean, Boolean, String) Revokes previously granted permissions from a grantee on the extended 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.
Public method Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean, String) Revokes previously granted permissions from grantees on the extended 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.
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

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

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method 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.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method 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.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)

Top

Remarks

Extended stored procedures are user-defined routines in a programming language such as C that extend the functionality of SQL Server. Extended stored procedures are executed in the same way as stored procedures on an instance of SQL Server. They can be passed parameters and return values.

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

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

To create a extended 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 extended stored procedure, users must have CONTROL permission on the extended 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.

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

Extended Stored Procedures