FaultConverter.OnTryCreateException(Message, MessageFault, Exception) Method

Reference

Definition

Namespace:: System.ServiceModel.Channels

Assembly:: System.ServiceModel.Primitives.dll

Assembly:: System.ServiceModel.dll

Package:: System.ServiceModel.Primitives v6.0.0

Package:: System.ServiceModel.Primitives v6.2.0

Package:: System.ServiceModel.Primitives v8.0.0

Source:: FaultConverter.cs

Source:: FaultConverter.cs

Source:: FaultConverter.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.

Tries to create the exception.

protected:
 abstract bool OnTryCreateException(System::ServiceModel::Channels::Message ^ message, System::ServiceModel::Channels::MessageFault ^ fault, [Runtime::InteropServices::Out] Exception ^ % exception);

protected abstract bool OnTryCreateException (System.ServiceModel.Channels.Message message, System.ServiceModel.Channels.MessageFault fault, out Exception exception);

abstract member OnTryCreateException : System.ServiceModel.Channels.Message * System.ServiceModel.Channels.MessageFault * Exception -> bool

Protected MustOverride Function OnTryCreateException (message As Message, fault As MessageFault, ByRef exception As Exception) As Boolean

Parameters

message: Message

The fault message.

fault: MessageFault

The fault.

exception: Exception

If conversion is successful, the SOAP exception, returned as an out parameter.

Returns

Boolean

true if fault was successfully converted; otherwise, false. The default is false.

Remarks

For a channel layer to implement GetProperty<FaultConverter> to support converting fault messages to SOAP exceptions, override this method to create an exception by doing the following steps:

Inspect the fault message.
If recognized, do the appropriate conversion.
If not recognized, convert it by a call to GetProperty<FaultConverter> on the inner channel.

Transport channels should delegate to GetDefaultFaultConverter to get the default SOAP/WS-Addressing fault converter.

Applies to