This topic has not yet been rated - Rate this topic

SqlUserDefinedTypeAttribute Class

.NET Framework 4.5

Used to mark a type definition in an assembly as a user-defined type (UDT) in SQL Server. The properties on the attribute reflect the physical characteristics used when the type is registered with SQL Server. This class cannot be inherited.

Inheritance Hierarchy

System.Object
System.Attribute
Microsoft.SqlServer.Server.SqlUserDefinedTypeAttribute

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

Syntax

C++

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class Or AttributeTargets.Struct, AllowMultiple := False,  _
	Inherited := True)> _
Public NotInheritable Class SqlUserDefinedTypeAttribute _
	Inherits Attribute

The SqlUserDefinedTypeAttribute type exposes the following members.

Constructors

	Name	Description
	SqlUserDefinedTypeAttribute	A required attribute on a user-defined type (UDT), used to confirm that the given type is a UDT and to indicate the storage format of the UDT.

Top

Properties

	Name	Description
	Format	The serialization format as a Format.
	IsByteOrdered	Indicates whether the user-defined type is byte ordered.
	IsFixedLength	Indicates whether all instances of this user-defined type are the same length.
	MaxByteSize	The maximum size of the instance, in bytes.
	Name	The SQL Server name of the user-defined type.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
	ValidationMethodName	The name of the method used to validate instances of the user-defined type.

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	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.)
	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

Remarks

SQL Server creates a user-defined type that is bound to the type definition that has the SqlUserDefinedTypeAttribute custom attribute. Every UDT must be annotated with this attribute. See CLR User-Defined Types for more information about UDTs, including an example of a UDT.

Examples

The following example shows the UserDefinedType attribute of the Point UDT. The UDT is byte-ordered, is named "Point", has a validation method named "ValidatePoint", and uses the native serialization format.

<Serializable(), SqlUserDefinedTypeAttribute(Format.Native, _
  IsByteOrdered:=True, _
  Name:="Point", _
  ValidationMethodName:="ValidatePoint")> _
  Public Structure Point
    Implements INullable

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)