SqlCeSyncDescriptionBuilder.GetDescriptionForTable Method (String, )

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

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

Syntax

'Declaration
Public Shared Function GetDescriptionForTable ( _
    tableName As String, _
    connection As SqlCeConnection _
) As DbSyncTableDescription
'Usage
Dim tableName As String
Dim connection As SqlCeConnection
Dim returnValue As DbSyncTableDescription

returnValue = SqlCeSyncDescriptionBuilder.GetDescriptionForTable(tableName, _
    connection)
public static DbSyncTableDescription GetDescriptionForTable(
    string tableName,
    SqlCeConnection connection
)
public:
static DbSyncTableDescription^ GetDescriptionForTable(
    String^ tableName, 
    SqlCeConnection^ connection
)
static member GetDescriptionForTable : 
        tableName:string * 
        connection:SqlCeConnection -> DbSyncTableDescription 
public static function GetDescriptionForTable(
    tableName : String, 
    connection : SqlCeConnection
) : DbSyncTableDescription

Parameters

  • tableName
    Type: System.String
    The name of the table for which to retrieve a description.
  • connection
    Type: SqlCeConnection
    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.

Exceptions

Exception Condition
ArgumentNullException

tableName or connection is a null reference (Nothing in Visual Basic).

See Also

Reference

SqlCeSyncDescriptionBuilder Class

GetDescriptionForTable Overload

Microsoft.Synchronization.Data.SqlServerCe Namespace