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)
The SqlFacetAttribute type exposes the following members.
| Name | Description | |
|---|---|---|
|
SqlFacetAttribute | An 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. |
| Name | Description | |
|---|---|---|
|
IsFixedLength | Indicates whether the return type of the user-defined type is of a fixed length. |
|
|
IsNullable | Indicates whether the return type of the user-defined type can be null. |
|
|
MaxSize | The maximum size, in logical units, of the underlying field type of the user-defined type. |
|
|
Precision | The precision of the return type of the user-defined type. |
|
|
Scale | The scale of the return type of the user-defined type. |
|
|
TypeId | When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.) |
| Name | Description | |
|---|---|---|
|
|
Equals | Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
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.) |
|
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
| 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.) |
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 |
N |
Y1 |
N |
|
|
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.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
