BusinessLogicModule.UpdateErrorHandler Method
Definition
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.
Optional method that implements the custom business logic invoked when an error occurs at the time an UPDATE statement is being uploaded or downloaded.
public:
virtual Microsoft::SqlServer::Replication::BusinessLogicSupport::ActionOnDataError UpdateErrorHandler(Microsoft::SqlServer::Replication::BusinessLogicSupport::SourceIdentifier updateSource, System::Data::DataSet ^ updatedDataSet, Microsoft::SqlServer::Replication::BusinessLogicSupport::ErrorLogType % errorLogType, System::String ^ % customErrorMessage, int errorCode, System::String ^ errorMessage, int % historyLogLevel, System::String ^ % historyLogMessage);
public virtual Microsoft.SqlServer.Replication.BusinessLogicSupport.ActionOnDataError UpdateErrorHandler (Microsoft.SqlServer.Replication.BusinessLogicSupport.SourceIdentifier updateSource, System.Data.DataSet updatedDataSet, ref Microsoft.SqlServer.Replication.BusinessLogicSupport.ErrorLogType errorLogType, ref string customErrorMessage, int errorCode, string errorMessage, ref int historyLogLevel, ref string historyLogMessage);
abstract member UpdateErrorHandler : Microsoft.SqlServer.Replication.BusinessLogicSupport.SourceIdentifier * System.Data.DataSet * ErrorLogType * string * int * string * int * string -> Microsoft.SqlServer.Replication.BusinessLogicSupport.ActionOnDataError
override this.UpdateErrorHandler : Microsoft.SqlServer.Replication.BusinessLogicSupport.SourceIdentifier * System.Data.DataSet * ErrorLogType * string * int * string * int * string -> Microsoft.SqlServer.Replication.BusinessLogicSupport.ActionOnDataError
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
Parameters
- updateSource
- SourceIdentifier
SourceIdentifier that indicates whether the source of the update that generated the error is the Publisher or the Subscriber.
- updatedDataSet
- DataSet
Dataset representing the UPDATE statement that caused the error.
- errorLogType
- ErrorLogType
ErrorLogType output parameter that controls how replication logs the error. This parameter is used only if the return value is AcceptCustomErrorBehavior.
- customErrorMessage
- String
Output parameter used to return a custom error message. This parameter is used only if the return value is AcceptCustomErrorBehavior.
- errorCode
- Int32
Error code that corresponds to the underlying replication error that occurred.
- errorMessage
- String
Error message text that corresponds to the underlying replication error that occurred.
- historyLogLevel
- Int32
Log level of the custom message returned by the custom business logic handler.
- historyLogMessage
- String
Log message provided by custom business logic handler. The log message gets written to the distribution database.
Returns
The ActionOnDataError action that will be taken by the process after the custom business logic handler has executed.