1 out of 1 rated this helpful - Rate this topic

SqlFunctionAttribute Class

.NET Framework 4.5

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.

Inheritance Hierarchy

System.Object
  System.Attribute
    Microsoft.SqlServer.Server.SqlFunctionAttribute
      Microsoft.SqlServer.Server.SqlMethodAttribute

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

Syntax

C++

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

The SqlFunctionAttribute type exposes the following members.

Constructors

	Name	Description
	SqlFunctionAttribute	An optional attribute on a user-defined aggregate, used to indicate that the method should be registered in SQL Server as a function. Also used to set the DataAccess, FillRowMethodName, IsDeterministic, IsPrecise, Name, SystemDataAccess, and TableDefinition properties of the function attribute.

Top

Properties

	Name	Description
	DataAccess	Indicates whether the function involves access to user data stored in the local instance of SQL Server.
	FillRowMethodName	The name of a method in the same class as the table-valued function (TVF) that is used by the TVF contract.
	IsDeterministic	Indicates whether the user-defined function is deterministic.
	IsPrecise	Indicates whether the function involves imprecise computations, such as floating point operations.
	Name	The name under which the function should be registered in SQL Server.
	SystemDataAccess	Indicates whether the function requires access to data stored in the system catalogs or virtual system tables of SQL Server.
	TableDefinition	A string that represents the table definition of the results, if the method is used as a table-valued function (TVF).
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	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	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.)

Top

Explicit Interface Implementations

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

Top

Examples

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

[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() };
   }
			
}

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

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.

Reference

Microsoft.SqlServer.Server Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)