.NET Framework Class Library
SqlFunctionAttribute Class

Used to mark a method definition of a user-defined aggregate as a function in SQL Server. The properties on the attribute reflect the physical characteristics used when the type is registered with SQL Server.

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

Visual Basic (Declaration)
<SerializableAttribute> _
<AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple := False, Inherited := False)> _
Public Class SqlFunctionAttribute _
    Inherits Attribute
Visual Basic (Usage)
Dim instance As SqlFunctionAttribute
C#
[SerializableAttribute]
[AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
public class SqlFunctionAttribute : Attribute
Visual C++
[SerializableAttribute]
[AttributeUsageAttribute(AttributeTargets::Method, AllowMultiple = false, Inherited = false)]
public ref class SqlFunctionAttribute : public Attribute
JScript
public class SqlFunctionAttribute extends Attribute
Examples

The following example shows an aggregate function that returns a list of files in the specified directory path.

Visual Basic
<SqlFunction(FillRowMethodName:="FillFileRow")> _
Public Shared Function GetFileDetails(ByVal directoryPath As String) As IEnumerable

   Try

      Dim di As DirectoryInfo = new DirectoryInfo(directoryPath)
      return di.GetFiles()

   Catch dnf As DirectoryNotFoundException

      Dim message As String() = {dnf.ToString() }
      return message

   End Try
End Function
C#
[SqlFunctionAttribute(FillRowMethodName = "FillFileRow")]
public static IEnumerable GetFileDetails(string directoryPath)
{
   try
   {
      DirectoryInfo di = new DirectoryInfo(directoryPath);
      return di.GetFiles();
   }
   catch (DirectoryNotFoundException dnf)
   {
      return new string[1] { dnf.ToString() };
   }
            
}
Inheritance Hierarchy

System..::.Object
  System..::.Attribute
    Microsoft.SqlServer.Server..::.SqlFunctionAttribute
      Microsoft.SqlServer.Server..::.SqlMethodAttribute
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
See Also

Reference

Tags :


Page view tracker