DbServerSyncProvider::GetSchema Method

Returns a SyncSchema object that contains the schema for each table specified.

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

public:
virtual SyncSchema^ GetSchema(
	Collection<String^>^ tableNames, 
	SyncSession^ syncSession
) override

Parameters

tableNames
Type: System.Collections.ObjectModel::Collection<String>
A collection of table names for which the server provider should get the schema.
syncSession
Type: Microsoft.Synchronization.Data::SyncSession
A SyncSession object that contains synchronization session variables, such as the ID of the client that is synchronizing.

Return Value

Type: Microsoft.Synchronization.Data::SyncSchema
A SyncSchema object that contains the schema for each table that is specified.

ExceptionCondition
ArgumentNullException

tableNames is a nullptr.

SchemaException

The schema could not be read.

This method will try to obtain schemas from the Schema property. If the schema cannot be found and the server database is SQL Server, this method will try to obtain the schema directly from the underlying database.

Show: