BusinessLogicModule.InsertErrorHandler Method
Optional method implements the custom business logic invoked when an error occurs at the time an INSERT 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 InsertErrorHandler ( _
insertSource As SourceIdentifier, _
insertedDataSet 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
'Usage
Dim instance As BusinessLogicModule
Dim insertSource As SourceIdentifier
Dim insertedDataSet As DataSet
Dim errorLogType As ErrorLogType
Dim customErrorMessage As String
Dim errorCode As Integer
Dim errorMessage As String
Dim historyLogLevel As Integer
Dim historyLogMessage As String
Dim returnValue As ActionOnDataError
returnValue = instance.InsertErrorHandler(insertSource, _
insertedDataSet, errorLogType, customErrorMessage, _
errorCode, errorMessage, historyLogLevel, _
historyLogMessage)
public virtual ActionOnDataError InsertErrorHandler(
SourceIdentifier insertSource,
DataSet insertedDataSet,
ref ErrorLogType errorLogType,
ref string customErrorMessage,
int errorCode,
string errorMessage,
ref int historyLogLevel,
ref string historyLogMessage
)
public:
virtual ActionOnDataError InsertErrorHandler(
SourceIdentifier insertSource,
DataSet^ insertedDataSet,
ErrorLogType% errorLogType,
String^% customErrorMessage,
int errorCode,
String^ errorMessage,
int% historyLogLevel,
String^% historyLogMessage
)
abstract InsertErrorHandler :
insertSource:SourceIdentifier *
insertedDataSet:DataSet *
errorLogType:ErrorLogType byref *
customErrorMessage:string byref *
errorCode:int *
errorMessage:string *
historyLogLevel:int byref *
historyLogMessage:string byref -> ActionOnDataError
override InsertErrorHandler :
insertSource:SourceIdentifier *
insertedDataSet:DataSet *
errorLogType:ErrorLogType byref *
customErrorMessage:string byref *
errorCode:int *
errorMessage:string *
historyLogLevel:int byref *
historyLogMessage:string byref -> ActionOnDataError
public function InsertErrorHandler(
insertSource : SourceIdentifier,
insertedDataSet : DataSet,
errorLogType : ErrorLogType,
customErrorMessage : String,
errorCode : int,
errorMessage : String,
historyLogLevel : int,
historyLogMessage : String
) : ActionOnDataError
Parameters
- insertSource
Type: Microsoft.SqlServer.Replication.BusinessLogicSupport.SourceIdentifier
SourceIdentifier that indicates whether the source of the insert that generated the error is the Publisher or the Subscriber.
- insertedDataSet
Type: System.Data.DataSet
Dataset that contains the GUID of the row that was inserted.
- errorLogType
Type: Microsoft.SqlServer.Replication.BusinessLogicSupport.ErrorLogType%
ErrorLogType output parameter that controls how replication logs the error. This parameter is used only if the return value is AcceptCustomErrorBehavior.
- customErrorMessage
Type: System.String%
Output parameter used to return a custom error message. This parameter is only used if the return value is AcceptCustomErrorBehavior.
- errorCode
Type: System.Int32
Error code that corresponds to the underlying replication error that occurred.
- errorMessage
Type: System.String
Error message text that corresponds to the underlying replication error that occurred.
- historyLogLevel
Type: System.Int32%
Log level of the custom message returned by the custom business logic handler.
- historyLogMessage
Type: System.String%
Log message provided by the custom business logic handler. The log message gets written to the distribution database.
Return Value
Type: Microsoft.SqlServer.Replication.BusinessLogicSupport.ActionOnDataError
The ActionOnDataError action that will be taken by the process after the custom business logic handler has executed.