.NET Framework Class Library
SqlFacetAttribute Class

Annotates the returned result of a user-defined type (UDT) with additional information that can be used in Transact-SQL.

Inheritance Hierarchy
SystemObject
   SystemAttribute
    Microsoft.SqlServer.ServerSqlFacetAttribute

Namespace:   Microsoft.SqlServer.Server
Assembly:  System.Data (in System.Data.dll)
Syntax
<[%$TOPIC/ms127212_en-us_VS_110_2_0_0_0_0%]([%$TOPIC/ms127212_en-us_VS_110_2_0_0_0_1%].Property Or [%$TOPIC/ms127212_en-us_VS_110_2_0_0_0_2%].Field Or [%$TOPIC/ms127212_en-us_VS_110_2_0_0_0_3%].Parameter Or [%$TOPIC/ms127212_en-us_VS_110_2_0_0_0_4%].ReturnValue, AllowMultiple := False,  _
	Inherited := False)> _
Public Class SqlFacetAttribute _
	Inherits [%$TOPIC/ms127212_en-us_VS_110_2_0_0_0_5%]
[[%$TOPIC/ms127212_en-us_VS_110_2_0_1_0_0%]([%$TOPIC/ms127212_en-us_VS_110_2_0_1_0_1%].Property|[%$TOPIC/ms127212_en-us_VS_110_2_0_1_0_2%].Field|[%$TOPIC/ms127212_en-us_VS_110_2_0_1_0_3%].Parameter|[%$TOPIC/ms127212_en-us_VS_110_2_0_1_0_4%].ReturnValue, AllowMultiple = false, 
	Inherited = false)]
public class SqlFacetAttribute : [%$TOPIC/ms127212_en-us_VS_110_2_0_1_0_5%]
[[%$TOPIC/ms127212_en-us_VS_110_2_0_2_0_0%]([%$TOPIC/ms127212_en-us_VS_110_2_0_2_0_1%]::Property|[%$TOPIC/ms127212_en-us_VS_110_2_0_2_0_2%]::Field|[%$TOPIC/ms127212_en-us_VS_110_2_0_2_0_3%]::Parameter|[%$TOPIC/ms127212_en-us_VS_110_2_0_2_0_4%]::ReturnValue, AllowMultiple = false, 
	Inherited = false)]
public ref class SqlFacetAttribute : public [%$TOPIC/ms127212_en-us_VS_110_2_0_2_0_5%]
[<[%$TOPIC/ms127212_en-us_VS_110_2_0_3_0_0%]([%$TOPIC/ms127212_en-us_VS_110_2_0_3_0_1%].Property|[%$TOPIC/ms127212_en-us_VS_110_2_0_3_0_2%].Field|[%$TOPIC/ms127212_en-us_VS_110_2_0_3_0_3%].Parameter|[%$TOPIC/ms127212_en-us_VS_110_2_0_3_0_4%].ReturnValue, AllowMultiple = false, 
    Inherited = false)>]
type SqlFacetAttribute =  
    class 
        inherit [%$TOPIC/ms127212_en-us_VS_110_2_0_3_0_5%] 
    end

The SqlFacetAttribute type exposes the following members.

Constructors
  NameDescription
Public method SqlFacetAttributeAn optional attribute on a user-defined type (UDT) return type, used to annotate the returned result with additional information that can be used in Transact-SQL.
Top
Properties
  NameDescription
Public property IsFixedLengthIndicates whether the return type of the user-defined type is of a fixed length.
Public property IsNullableIndicates whether the return type of the user-defined type can be .
Public property MaxSizeThe maximum size, in logical units, of the underlying field type of the user-defined type.
Public property PrecisionThe precision of the return type of the user-defined type.
Public property ScaleThe scale of the return type of the user-defined type.
Public property TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
Top
Methods
  NameDescription
Public method EqualsInfrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Protected method FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCodeReturns the hash code for this instance. (Inherited from Attribute.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Protected method MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implemetation Private method _AttributeGetIDsOfNamesMaps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoRetrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeGetTypeInfoCountRetrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetation Private method _AttributeInvokeProvides access to properties and methods exposed by an object. (Inherited from Attribute.)
Top
Remarks

SqlFacetAttribute may only be specified on non-void return values.

SqlFacetAttribute is used only to derive information about the return type, and is not intended to be a constraint specification on what can be stored in the type. Thus, if a field has a SqlFacetAttribute indicating its size to be 2 characters, then the SQL Server type of the field access expression is of size 2, but assignments into the field are not restricted by this facet.

The table below captures the matrix of valid values for the various properties for specific field types. In this table, "Y" indicates that the property is valid, and "N" indicates that the property is not valid.

The specified SqlFacetAttribute must be compatible with the field type. If the property is not valid, type registration will report an error if the user specifies a non-default value for the property. The maximum values for Precision and Scale properties are 38. For the MaxSize property, the value should be in the range of 1-8000 for binary and non-Unicode data, 1-4000 for Unicode data, or -1. All other values are not valid.

Type

IsFixedLength

MaxSize

Precision

Scale

IsNullable

SqlBoolean

N

N

N

N

Y

SqlByte

N

N

N

N

Y

SqlInt16

N

N

N

N

Y

SqlInt32

N

N

N

N

Y

SqlInt64

N

N

N

N

Y

SqlSingle

N

N

N

N

Y

SqlDouble

N

N

N

N

Y

SqlDateTime

N

N

N

N

Y

SqlMoney

N

N

N

N

Y

SqlGuid

N

N

N

N

Y

SqlDecimal

N

N

Y

Y

Y

SqlString

Y

Y

N

N

Y

SqlBinary

Y

Y

N

N

Y

SqlXml

N

N

N

N

Y

SqlBytes

Y

Y

N

N

Y

SqlChars

Y

Y

N

N

Y

Embedded UDTs

N

N

N

N

Y

String

Y

Y

N

N

Y

Byte[]

Y

Y

N

N

Y

Char[]

Y

Y

N

N

Y

DateTime

N

N

N

Y1

N

Decimal

N

N

Y

Y

Y

(1) Specifying the scale on a DateTime type will cause the value to be returned to Transact-SQL as a DateTime2 type with the specified scale.

Version Information

.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, 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.