This documentation is archived and is not being maintained.

SqlDataRecord.GetSqlMetaData Method

Note: This method is new in the .NET Framework version 2.0.

Returns a SqlMetaData object, describing the metadata of the column specified by the column ordinal.

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

public SqlMetaData GetSqlMetaData (
	int ordinal
public SqlMetaData GetSqlMetaData (
	int ordinal
public function GetSqlMetaData (
	ordinal : int
) : SqlMetaData



The zero-based ordinal of the column.

Return Value

The column metadata as a SqlMetaData object.

Exception typeCondition


The ordinal is less than 0 or greater than the number of columns (that is, FieldCount).


There is a type mismatch.

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0