SqlMetaData Constructor (String, SqlDbType)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Initializes a new instance of the SqlMetaData class with the specified column name and type.

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

public SqlMetaData(
	string name,
	SqlDbType dbType
)

Parameters

name
Type: System.String

The name of the column.

dbType
Type: System.Data.SqlDbType

The SQL Server type of the parameter or column.

Exception Condition
ArgumentNullException

The Name is null.

ArgumentException

A SqlDbType that is not allowed was passed to the constructor as dbType.

Only the following are allowed to be passed to the constructor as dbType: Bit, BigInt, DateTime, Decimal, Float, Int, Money, Numeric, SmallDateTime, SmallInt, SmallMoney, TimeStamp, TinyInt, UniqueIdentifier, Xml.

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

SqlDbType

Maximum length

Precision

Scale

Locale

Compare options

Bit

1

1

0

0

None

BigInt

8

19

0

0

None

DateTime

8

23

3

0

None

Decimal

9

18

0

0

None

Float

8

53

0

0

None

Int

4

10

0

0

None

Money

8

19

4

0

None

Numeric

9

18

0

0

None

SmallDateTime

4

16

0

0

None

SmallInt

2

5

0

0

None

SmallMoney

4

10

4

0

None

TimeStamp

8

0

0

0

None

TinyInt

1

3

0

0

None

UniqueIdentifier

16

0

0

0

None

Xml

Max (-1)

0

0

0

IgnoreCase, IgnoreKanaType, IgnoreWidth

The following example creates a new SqlMetaData object by specifying the column name and a column data type of SqlDbType.Int.

public static void CreateSqlMetaData2()
{
   SqlMetaData columnInfo;
   columnInfo = new SqlMetaData("Column2", SqlDbType.Int);
}

.NET Framework
Available since 2.0
Return to top
Show: