SqlProcedureAttribute Class

Reference

Definition

Namespace:: Microsoft.SqlServer.Server

Assembly:: System.Data.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

[<System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)>]
[<System.Serializable>]
type SqlProcedureAttribute = class
    inherit Attribute

Public NotInheritable Class SqlProcedureAttribute
Inherits Attribute

Inheritance: 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.

Applies to

Share via