SqlSyncProvider.BeginSession Method

Called by the SyncOrchestrator to indicate that a synchronization session has started.

This API is not CLS-compliant. 

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

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Overrides Sub BeginSession ( _
    position As SyncProviderPosition, _
    syncSessionContext As SyncSessionContext _
)
'Usage
Dim instance As SqlSyncProvider
Dim position As SyncProviderPosition
Dim syncSessionContext As SyncSessionContext

instance.BeginSession(position, syncSessionContext)

[CLSCompliantAttribute(false)]
public override void BeginSession(
    SyncProviderPosition position,
    SyncSessionContext syncSessionContext
)

[CLSCompliantAttribute(false)]
public:
virtual void BeginSession(
    SyncProviderPosition position, 
    SyncSessionContext^ syncSessionContext
) override

[<CLSCompliantAttribute(false)>]
abstract BeginSession : 
        position:SyncProviderPosition * 
        syncSessionContext:SyncSessionContext -> unit 
[<CLSCompliantAttribute(false)>]
override BeginSession : 
        position:SyncProviderPosition * 
        syncSessionContext:SyncSessionContext -> unit 

public override function BeginSession(
    position : SyncProviderPosition, 
    syncSessionContext : SyncSessionContext
)

Parameters

• position
  Type: Microsoft.Synchronization.SyncProviderPosition
  A SyncProviderPosition enumeration value that represents whether a provider is associated with the local or remote database.

• syncSessionContext
  Type: Microsoft.Synchronization.SyncSessionContext
  A SyncSessionContext object that contains information about the current synchronization session.

Exceptions

Exception	Condition
DbSyncException	A session is already begun.

See Also

Reference

SqlSyncProvider Class

Microsoft.Synchronization.Data.SqlServer Namespace