SyncUpdateCallback Delegate

.NET Framework (current version)
 

Receives event notifications during a replica synchronization.

Namespace:   System.DirectoryServices.ActiveDirectory
Assembly:  System.DirectoryServices (in System.DirectoryServices.dll)

C#
C++
F#
VB
Copy 
public delegate bool SyncUpdateCallback(
	SyncFromAllServersEvent eventType,
	String^ targetServer,
	String^ sourceServer,
	SyncFromAllServersOperationException^ exception
)

Parameters

eventType
Type: System.DirectoryServices.ActiveDirectory::SyncFromAllServersEvent

One of the SyncFromAllServersEvent members that specifies the type of event.

targetServer
Type: System::String^

Contains the DNS name of the server that is the target of the replication. This parameter will be null if it is not used by the notification.

sourceServer
Type: System::String^

Contains the DNS name of the server that is the source of the replication. This parameter will be null if it is not used by the notification.

exception
Type: System.DirectoryServices.ActiveDirectory::SyncFromAllServersOperationException^

A SyncFromAllServersOperationException object that contains additional information about any error that has occurred. This parameter will be null if no error has occurred.

Return Value

Type: System::Boolean

true if the SyncReplicaFromAllServers method invoked on a T:System.DirectoryServices.ActiveDirectory.ADAMInstance, DirectoryServer or DomainController object should resume; false if the SyncReplicaFromAllServers method should terminate.

The SyncReplicaFromAllServers

operation takes a long time to complete and potentially could fail on a server. The SyncUpdateCallback callback function enables the application to indicate whether the SyncReplicaFromAllServers method should continue executing. For example, the application could return false to terminate SyncReplicaFromAllServers

execution if an error occurs. Another scenario in which this capability would be used is to terminate SyncReplicaFromAllServers

execution once the application detects that synchronization has completed for a certain target server or source server pair.

.NET Framework
Available since 2.0
Return to top
Show: