LinkedServer.EnumColumns Method (String, String, String)

  • Article

Enumerates a list of columns that can be accessed on the linked server for a specified table, schema, and database.

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public Function EnumColumns ( _
    tableName As String, _
    schemaName As String, _
    databaseName As String _
) As DataTable
'Usage
Dim instance As LinkedServer 
Dim tableName As String 
Dim schemaName As String 
Dim databaseName As String 
Dim returnValue As DataTable 

returnValue = instance.EnumColumns(tableName, _
    schemaName, databaseName)

public DataTable EnumColumns(
    string tableName,
    string schemaName,
    string databaseName
)

public:
DataTable^ EnumColumns(
    String^ tableName, 
    String^ schemaName, 
    String^ databaseName
)

member EnumColumns : 
        tableName:string * 
        schemaName:string * 
        databaseName:string -> DataTable

public function EnumColumns(
    tableName : String, 
    schemaName : String, 
    databaseName : String
) : DataTable

Parameters

Return Value

Type: System.Data.DataTable
A DataTable object value that contains a list of tables that can be accessed on the linked server. The table describes the different columns of the returned DataTable.

Column

Data type

Description

COLUMN_SIZE

Int32

The number of significant digits in the column. The return value for the PRECISION column is in base 10.

BUFFER_LENGTH

Int32

The transfer size of the data to and from the column.

DECIMAL_DIGITS

Int32

The number of digits to the right of the decimal point.

NUM_PREC_RADIX

Int32

The base for numeric data types.

NULLABLE

Int32

The nullability of the column.

1 = NULL is possible.

0 = NOT NULL.

REMARKS

String

This field always returns NULL.

COLUMN_DEF

String

The default value of the column.

SQL_DATA_TYPE

Int32

The value of the SQL data type as it appears in the TYPE field of the descriptor. This column is the same as the DATA_TYPE column, except for the DateTime and ISO interval data types. This column always returns a value.

SQL_DATETIMEE_SUB

Int32

The subtype code for DateTime and ISO interval data types. For other data types, this column returns NULL.

CHAR_OCTET_LENGTH

Int32

The maximum length in bytes of a character or integer data type column. For all other data types, this column returns NULL.

ORDINAL_POSITION

Int32

The ordinal position of the column in the table. The first column in the table is 1. This column always returns a value.

IS_NULLABLE

String

The nullability of the column in the table. ISO rules are followed to determine nullability. An ISO SQL-compliant DBMS cannot return an empty string.

YES = Column can include NULLS.

NO = Column cannot include NULLS.

This column returns a zero-length string if nullability is unknown.

The value returned for this column is different from the value returned for the NULLABLE column.

SS_DATA_TYPE

Int32

The ordinal position of the column in the table. The first column in the table is 1. This column always returns a value.

Examples

Using Linked Servers in SMO

See Also

Reference

LinkedServer Class

EnumColumns Overload

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Linked Servers (Database Engine)

sp_addlinkedserver (Transact-SQL)

sp_columns_ex (Transact-SQL)