SqlProcedureAttribute Class (Microsoft.SqlServer.Server)

.NET Framework Class Library

SqlProcedureAttribute Class

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.

Namespace: Microsoft.SqlServer.Server
Assembly: System.Data (in System.Data.dll)

Syntax

Visual Basic (Declaration)

<SerializableAttribute> _
<AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple := False, Inherited := False)> _
Public NotInheritable Class SqlProcedureAttribute _
    Inherits Attribute

Visual Basic (Usage)

Dim instance As SqlProcedureAttribute

[SerializableAttribute]
[AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
public sealed class SqlProcedureAttribute : Attribute

Visual C++

[SerializableAttribute]
[AttributeUsageAttribute(AttributeTargets::Method, AllowMultiple = false, Inherited = false)]
public ref class SqlProcedureAttribute sealed : public Attribute

JScript

public final class SqlProcedureAttribute extends Attribute

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.

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.

Visual Basic

<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

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

Inheritance Hierarchy

System..::.Object
System..::.Attribute
Microsoft.SqlServer.Server..::.SqlProcedureAttribute

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.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

SqlProcedureAttribute Members

Microsoft.SqlServer.Server Namespace