SyncUpdateCallback Delegate

Reference

Definition

Namespace:: System.DirectoryServices.ActiveDirectory

Assembly:: System.DirectoryServices.dll

Package:: System.DirectoryServices v8.0.0

Package:: System.DirectoryServices v9.0.0-rc.2.24473.5

Source:: DomainController.cs

Source:: DomainController.cs

Source:: DomainController.cs

Source:: DomainController.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Receives event notifications during a replica synchronization.

public delegate bool SyncUpdateCallback(SyncFromAllServersEvent eventType, System::String ^ targetServer, System::String ^ sourceServer, SyncFromAllServersOperationException ^ exception);

public delegate bool SyncUpdateCallback(SyncFromAllServersEvent eventType, string? targetServer, string? sourceServer, SyncFromAllServersOperationException? exception);

public delegate bool SyncUpdateCallback(SyncFromAllServersEvent eventType, string targetServer, string sourceServer, SyncFromAllServersOperationException exception);

type SyncUpdateCallback = delegate of SyncFromAllServersEvent * string * string * SyncFromAllServersOperationException -> bool

Public Delegate Function SyncUpdateCallback(eventType As SyncFromAllServersEvent, targetServer As String, sourceServer As String, exception As SyncFromAllServersOperationException) As Boolean

Parameters

eventType: SyncFromAllServersEvent

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

targetServer: 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: 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: 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

Boolean

true if the SyncReplicaFromAllServers method invoked on a AdamInstance, DirectoryServer or DomainController object should resume; false if the SyncReplicaFromAllServers method should terminate.

Remarks

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.

Extension Methods

GetMethodInfo(Delegate)

Gets an object that represents the method represented by the specified delegate.

Applies to

Share via