BusinessLogicModule.UpdateErrorHandler Method

Optional method that implements the custom business logic invoked when an error occurs at the time an UPDATE statement is being uploaded or downloaded.

Namespace: Microsoft.SqlServer.Replication.BusinessLogicSupport
Assembly: Microsoft.SqlServer.Replication.BusinessLogicSupport (in microsoft.sqlserver.replication.businesslogicsupport.dll)

Syntax

'Declaration
Public Overridable Function UpdateErrorHandler ( _
    updateSource As SourceIdentifier, _
    updatedDataSet As DataSet, _
    ByRef errorLogType As ErrorLogType, _
    ByRef customErrorMessage As String, _
    errorCode As Integer, _
    errorMessage As String, _
    ByRef historyLogLevel As Integer, _
    ByRef historyLogMessage As String _
) As ActionOnDataError

public virtual ActionOnDataError UpdateErrorHandler (
    SourceIdentifier updateSource,
    DataSet updatedDataSet,
    ref ErrorLogType errorLogType,
    ref string customErrorMessage,
    int errorCode,
    string errorMessage,
    ref int historyLogLevel,
    ref string historyLogMessage
)

public:
virtual ActionOnDataError UpdateErrorHandler (
    SourceIdentifier updateSource, 
    DataSet^ updatedDataSet, 
    ErrorLogType% errorLogType, 
    String^% customErrorMessage, 
    int errorCode, 
    String^ errorMessage, 
    int% historyLogLevel, 
    String^% historyLogMessage
)

public ActionOnDataError UpdateErrorHandler (
    SourceIdentifier updateSource, 
    DataSet updatedDataSet, 
    /** @ref */ ErrorLogType errorLogType, 
    /** @ref */ String customErrorMessage, 
    int errorCode, 
    String errorMessage, 
    /** @ref */ int historyLogLevel, 
    /** @ref */ String historyLogMessage
)

JScript does not support passing value-type arguments by reference.

Parameters

• updateSource
  SourceIdentifier that indicates whether the source of the update that generated the error is the Publisher or the Subscriber.

• updatedDataSet
  Dataset representing the UPDATE statement that caused the error.

• errorLogType
  ErrorLogType output parameter that controls how replication logs the error. This parameter is used only if the return value is AcceptCustomErrorBehavior.

• customErrorMessage
  Output parameter used to return a custom error message. This parameter is used only if the return value is AcceptCustomErrorBehavior.

• errorCode
  Error code that corresponds to the underlying replication error that occurred.

• errorMessage
  Error message text that corresponds to the underlying replication error that occurred.

• historyLogLevel
  Log level of the custom message returned by the custom business logic handler.

• historyLogMessage
  Log message provided by custom business logic handler. The log message gets written to the distribution database.

Return Value

The ActionOnDataError action that will be taken by the process after the custom business logic handler has executed.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

BusinessLogicModule Class
BusinessLogicModule Members
Microsoft.SqlServer.Replication.BusinessLogicSupport Namespace

Other Resources

Executing Business Logic During Merge Synchronization
How to: Implement a Business Logic Handler for a Merge Article (Replication Programming)