OnDispatchError Method (message, zone, info)

[This is preliminary documentation and is subject to change.]

Called when the Adk cannot dispatch a SIF_Event, SIF_Request, or SIF_Response message

Declaration Syntax

Visual Basic

Visual C++

bool OnDispatchError(
	SifMessagePayload message,
	IZone zone,
	IMessageInfo info
)

Function OnDispatchError ( _
	message As SifMessagePayload, _
	zone As IZone, _
	info As IMessageInfo _
) As Boolean

bool OnDispatchError (
	SifMessagePayload^ message, 
	IZone^ zone, 
	IMessageInfo^ info
)

Parameters

message (SifMessagePayload): The message that failed to dispatch
zone (IZone): The zone the message was received on
info (IMessageInfo): Additional information about the message (e.g. its header fields)

Return Value

true if this method has handled the error, or false if the Adk should apply its default error handling

Exceptions

Exception	Condition
SifException	SifException If a SifException is thrown, the Adk returns a SIF_Ack message to the Zone Integration Server using the error category, error code, description and extended description provided by the exception. Otherwise, a success SIF_Ack is returned.

Assembly: Edustructures.SifWorks.Adk (Module: Edustructures.SifWorks.Adk) Version: 2.0.0.10