SqlMethodAttribute Class

 

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.

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

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

<SerializableAttribute>
<AttributeUsageAttribute(AttributeTargets.Method, AllowMultiple := False,
	Inherited := False)>
Public NotInheritable Class SqlMethodAttribute
	Inherits SqlFunctionAttribute

NameDescription
System_CAPS_pubmethodSqlMethodAttribute()

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.

NameDescription
System_CAPS_pubpropertyDataAccess

Indicates whether the function involves access to user data stored in the local instance of SQL Server.(Inherited from SqlFunctionAttribute.)

System_CAPS_pubpropertyFillRowMethodName

The name of a method in the same class as the table-valued function (TVF) that is used by the TVF contract.(Inherited from SqlFunctionAttribute.)

System_CAPS_pubpropertyInvokeIfReceiverIsNull

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

System_CAPS_pubpropertyIsDeterministic

Indicates whether the user-defined function is deterministic.(Inherited from SqlFunctionAttribute.)

System_CAPS_pubpropertyIsMutator

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

System_CAPS_pubpropertyIsPrecise

Indicates whether the function involves imprecise computations, such as floating point operations.(Inherited from SqlFunctionAttribute.)

System_CAPS_pubpropertyName

The name under which the function should be registered in SQL Server.(Inherited from SqlFunctionAttribute.)

System_CAPS_pubpropertyOnNullCall

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

System_CAPS_pubpropertySystemDataAccess

Indicates whether the function requires access to data stored in the system catalogs or virtual system tables of SQL Server.(Inherited from SqlFunctionAttribute.)

System_CAPS_pubpropertyTableDefinition

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

System_CAPS_pubpropertyTypeId

When implemented in a derived class, gets a unique identifier for this Attribute.(Inherited from Attribute.)

NameDescription
System_CAPS_pubmethodEquals(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a value that indicates whether this instance is equal to a specified object.(Inherited from Attribute.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from Attribute.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodIsDefaultAttribute()

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.(Inherited from Attribute.)

System_CAPS_pubmethodMatch(Object)

When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.(Inherited from Attribute.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Maps a set of names to a corresponding set of dispatch identifiers.(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.GetTypeInfoCount(UInt32)

Retrieves the number of type information interfaces that an object provides (either 0 or 1).(Inherited from Attribute.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Provides access to properties and methods exposed by an object.(Inherited from Attribute.)

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.

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 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

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: