SqlFacetAttribute Class
Annotates the returned result of a user-defined type (UDT) with additional information that can be used in Transact-SQL.
Assembly: System.Data (in System.Data.dll)
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 |
|---|---|---|---|---|---|
N | N | N | N | Y | |
N | N | N | N | Y | |
N | N | N | N | Y | |
N | N | N | N | Y | |
N | N | N | N | Y | |
N | N | N | N | Y | |
N | N | N | N | Y | |
N | N | N | N | Y | |
N | N | N | N | Y | |
N | N | N | N | Y | |
N | N | Y | Y | Y | |
Y | Y | N | N | Y | |
Y | Y | N | N | Y | |
N | N | N | N | Y | |
Y | Y | N | N | Y | |
Y | Y | N | N | Y | |
Embedded UDTs | N | N | N | N | Y |
Y | Y | N | N | Y | |
Byte[] | Y | Y | N | N | Y |
Char[] | Y | Y | N | N | Y |
N | N | Y | Y | Y |
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.