SqlProcedureAttribute Class

Definition

Namespace:: Microsoft.SqlServer.Server

Assembly:: System.Data.dll

Used to mark a method definition in an assembly as a stored procedure. The properties on the attribute reflect the physical characteristics used when the type is registered with SQL Server. This class cannot be inherited.

public ref class SqlProcedureAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)]
[System.Serializable]
public sealed class SqlProcedureAttribute : Attribute

type SqlProcedureAttribute = class
    inherit Attribute

Public NotInheritable Class SqlProcedureAttribute
Inherits Attribute

Inheritance: Object

Attribute
SqlProcedureAttribute

Attributes: AttributeUsageAttribute SerializableAttribute

Examples

The following example shows a method declaration in an assembly that has been attributed as a stored procedure. The SqlProcedureAttribute property has been set to the name of the stored procedure.

[Microsoft.SqlServer.Server.SqlProcedure(Name = "StoredProcSendMessage")]
public static void StoredProcSendMessage()
{
    // Send a message string back to the client.
    SqlContext.Pipe.Send("Hello World!");
}

<Microsoft.SqlServer.Server.SqlProcedure(Name:="StoredProcSendMessage")> _
Public Shared Sub StoredProcSendMessage()

    ' Send a message string back to the client.
    SqlContext.Pipe.Send("Hello world!")

End Sub

Remarks

SqlProcedureAttribute is used only by Microsoft Visual Studio to automatically register the specified method as a stored procedure. It is not used by SQL Server.

See "CLR Stored Procedures" in SQL Server 2005 Books Online for more information on CLR stored procedures and examples.

Constructors

SqlProcedureAttribute()

An attribute on a method definition in an assembly, used to indicate that the given method should be registered as a stored procedure in SQL Server.

Properties

Name	The name of the stored procedure.
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Provides access to properties and methods exposed by an object. (Inherited from Attribute)