Annotates the returned result of a user-defined type (UDT) with additional information that can be used in Transact-SQL.
See Also: SqlFacetAttribute Members
Syntax
public class SqlFacetAttribute : Attribute
Remarks
Microsoft.SqlServer.Server.SqlFacetAttribute may only be specified on non-void return values.
Microsoft.SqlServer.Server.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 Microsoft.SqlServer.Server.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 Microsoft.SqlServer.Server.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 SqlFacetAttribute.Precision and SqlFacetAttribute.Scale properties are 38. For the SqlFacetAttribute.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.
| System.Data.SqlTypes.SqlBoolean |
N |
N |
N |
N |
Y |
| System.Data.SqlTypes.SqlByte |
N |
N |
N |
N |
Y |
| System.Data.SqlTypes.SqlInt16 |
N |
N |
N |
N |
Y |
| System.Data.SqlTypes.SqlInt32 |
N |
N |
N |
N |
Y |
| System.Data.SqlTypes.SqlInt64 |
N |
N |
N |
N |
Y |
| System.Data.SqlTypes.SqlSingle |
N |
N |
N |
N |
Y |
| System.Data.SqlTypes.SqlDouble |
N |
N |
N |
N |
Y |
| System.Data.SqlTypes.SqlDateTime |
N |
N |
N |
N |
Y |
| System.Data.SqlTypes.SqlMoney |
N |
N |
N |
N |
Y |
| System.Data.SqlTypes.SqlGuid |
N |
N |
N |
N |
Y |
| System.Data.SqlTypes.SqlDecimal |
N |
N |
Y |
Y |
Y |
| System.Data.SqlTypes.SqlString |
Y |
Y |
N |
N |
Y |
| System.Data.SqlTypes.SqlBinary |
Y |
Y |
N |
N |
Y |
| System.Data.SqlTypes.SqlXml |
N |
N |
N |
N |
Y |
| System.Data.SqlTypes.SqlBytes |
Y |
Y |
N |
N |
Y |
| System.Data.SqlTypes.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 |
Y |
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.
Requirements
Assembly: System.Data (in System.Data.dll)
Assembly Versions: 2.0.0.0
Since: .NET 2.0