SqlMethodAttribute SqlMethodAttribute SqlMethodAttribute SqlMethodAttribute Class

Definition

Indicates the determinism and data access properties of a method or property on a user-defined type (UDT). The properties on the attribute reflect the physical characteristics that are used when the type is registered with SQL Server.

public ref class SqlMethodAttribute sealed : Microsoft::SqlServer::Server::SqlFunctionAttribute
[System.AttributeUsage(System.AttributeTargets.Method, AllowMultiple=false, Inherited=false)]
[System.Serializable]
public sealed class SqlMethodAttribute : Microsoft.SqlServer.Server.SqlFunctionAttribute
type SqlMethodAttribute = class
    inherit SqlFunctionAttribute
Public NotInheritable Class SqlMethodAttribute
Inherits SqlFunctionAttribute
Inheritance
Attributes

Examples

The following example shows a UDT method that is attributed to indicate that the method will not be invoked on null instances of the type, that the method will not change the state of the type, and that the method will not be called when null parameters are supplied to the method invocation.

// Distance from Point to the specified x and y values method.
[SqlMethod(OnNullCall = false, IsMutator=false, InvokeIfReceiverIsNull=false)]
public Double DistanceFromXY(Int32 iX, Int32 iY)
{
   return Math.Sqrt(Math.Pow(iX - _x, 2.0) + Math.Pow(iY - _y, 2.0));
}
' Distance from Point to the specified x and y values method.
<SqlMethod(OnNullCall:=False, IsMutator:=False, InvokeIfReceiverIsNull:=False)> _
Public Function DistanceFromXY(ByVal ix As Int32, ByVal iy As Int32) _
    As Double

    Return Math.Sqrt(Math.Pow(ix - _x, 2.0) + Math.Pow(iy - _y, 2.0))

End Function

Remarks

For a property, the SqlMethodAttribute should be used on the setter or the getter directly.

SqlMethodAttribute inherits from a SqlFunctionAttribute, so SqlMethodAttribute inherits the FillRowMethodName and TableDefinition fields from SqlFunctionAttribute. Note that it is not possible to write a table-valued method, although the names of these fields might suggest that it is possible.

Constructors

SqlMethodAttribute() SqlMethodAttribute() SqlMethodAttribute() SqlMethodAttribute()

An attribute on a user-defined type (UDT), used to indicate the determinism and data access properties of a method or a property on a UDT.

Properties

DataAccess DataAccess DataAccess DataAccess

Indicates whether the function involves access to user data stored in the local instance of SQL Server.

(Inherited from SqlFunctionAttribute)
FillRowMethodName FillRowMethodName FillRowMethodName FillRowMethodName

The name of a method in the same class which is used to fill a row of data in the table returned by the table-valued function.

(Inherited from SqlFunctionAttribute)
InvokeIfReceiverIsNull InvokeIfReceiverIsNull InvokeIfReceiverIsNull InvokeIfReceiverIsNull

Indicates whether SQL Server should invoke the method on null instances.

IsDeterministic IsDeterministic IsDeterministic IsDeterministic

Indicates whether the user-defined function is deterministic.

(Inherited from SqlFunctionAttribute)
IsMutator IsMutator IsMutator IsMutator

Indicates whether a method on a user-defined type (UDT) is a mutator.

IsPrecise IsPrecise IsPrecise IsPrecise

Indicates whether the function involves imprecise computations, such as floating point operations.

(Inherited from SqlFunctionAttribute)
Name Name Name Name

The name under which the function should be registered in SQL Server.

(Inherited from SqlFunctionAttribute)
OnNullCall OnNullCall OnNullCall OnNullCall

Indicates whether the method on a user-defined type (UDT) is called when null input arguments are specified in the method invocation.

SystemDataAccess SystemDataAccess SystemDataAccess SystemDataAccess

Indicates whether the function requires access to data stored in the system catalogs or virtual system tables of SQL Server.

(Inherited from SqlFunctionAttribute)
TableDefinition TableDefinition TableDefinition TableDefinition

A string that represents the table definition of the results, if the method is used as a table-valued function (TVF).

(Inherited from SqlFunctionAttribute)
TypeId TypeId TypeId TypeId

When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Returns a value that indicates whether this instance is equal to a specified object.

(Inherited from Attribute)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Returns the hash code for this instance.

(Inherited from Attribute)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() 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) Match(Object) Match(Object) Match(Object)

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _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) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _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) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _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) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to