SqlSyncDescriptionBuilder::GetDescriptionForTable Method (String, Collection<String>, SqlConnection)

Returns a DbSyncTableDescription object that contains schema information about the specified table in a SQL Server database.

Namespace:  Microsoft.Synchronization.Data.SqlServer
Assembly:  Microsoft.Synchronization.Data.SqlServer (in Microsoft.Synchronization.Data.SqlServer.dll)

public:
static DbSyncTableDescription^ GetDescriptionForTable(
	String^ tableName, 
	Collection<String^>^ columnNames, 
	SqlConnection^ connection
)

Parameters

tableName
Type: System::String
The name of the table for which to retrieve a description.
columnNames
Type: System.Collections.ObjectModel::Collection<String>
A list of columns for which to retrieve information.
connection
Type: System.Data.SqlClient::SqlConnection
A SqlCeConnection object that contains a connection to the database.

Return Value

Type: Microsoft.Synchronization.Data::DbSyncTableDescription
A DbSyncTableDescription object that contains schema information about the specified table.

ExceptionCondition
ArgumentNullException

connection is nullptr.

ArgumentException

tableName is a nullptr or empty.

Show: