This documentation is archived and is not being maintained.

SqlMetaData Constructor (String, SqlDbType, Type)

Initializes a new instance of the SqlMetaData class with the specified column name, type, and user-defined type (UDT).

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

public:
SqlMetaData(
	String^ name, 
	SqlDbType dbType, 
	Type^ userDefinedType
)

Parameters

name
Type: System::String
The name of the column.
dbType
Type: System.Data::SqlDbType
The SQL Server type of the parameter or column.
userDefinedType
Type: System::Type
A Type instance that points to the UDT.

ExceptionCondition
ArgumentNullException

The Name is nullptr.

ArgumentException

A SqlDbType that is not allowed was passed to the constructor as dbType, or userDefinedType points to a type that does not have SqlUserDefinedTypeAttribute declared.

Only the following SqlDbType is allowed to be passed to the constructor as dbType: UDT.

The following are the default values assigned to dbType, depending on the SqlDbType (the XmlSchemaCollectionDatabase, XmlSchemaCollectionName, XmlSchemaCollectionOwningSchema, and Type properties are set to nullptr):

SqlDbType

Maximum length

Precision

Scale

Locale

Compare options

UDT

<Max length of the type> or -1

0

0

0

None

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.
Show: