Enables error-related processing and returns a value that indicates whether the dispatcher aborts the session and the instance context in certain cases.
Assembly: System.ServiceModel (in System.ServiceModel.dll)
- Type: System.Exception
The exception thrown during processing.
Use the method to implement error-related behaviors such as error logging, system notifications, shutting down the application, and so on, and return a value that specifies whether the exception has been handled appropriately.
Because the method can be called from many different places there are no guarantees made about which thread the method is called on. Do not depend on method being called on the operation thread.
All IErrorHandler implementations are called. By default (when the return value is false), if there is an exception, the dispatcher aborts any session and aborts the InstanceContext if the InstanceContextMode is anything other than Single. The exception is then considered unhandled and any state is considered corrupt.
Return true from to prevent this default behavior. If any error handler returns true it instructs WCF that it is safe to continue using state associated with the failed request.
If no error handler returns true from the method the exception is considered unhandled and the default response applies, potentially resulting in an aborted System.ServiceModel.InstanceContext and channel when communicating on a session channel or the ServiceBehaviorAttribute.InstanceContextMode property is not set to InstanceContextMode.Single.
The error parameter is never a null reference (Nothing in Visual Basic) and contains the exception object that was thrown.
The following code example shows how to configure the service to load the service behavior using an application configuration file. For more details about how to expose a service behavior in a configuration file, see IServiceBehavior.
<configuration> <system.serviceModel> <services> <service name="Microsoft.WCF.Documentation.SampleService" behaviorConfiguration="metaAndErrors"> <host> <baseAddresses> <add baseAddress="http://localhost:8080/SampleService"/> </baseAddresses> </host> <endpoint address="" binding="wsHttpBinding" contract="Microsoft.WCF.Documentation.ISampleService" /> <endpoint address="mex" binding="mexHttpBinding" contract="IMetadataExchange" /> </service> </services> <behaviors> <serviceBehaviors> <behavior name="metaAndErrors"> <serviceDebug includeExceptionDetailInFaults="true"/> <serviceMetadata httpGetEnabled="true"/> <enforceGreetingFaults /> </behavior> </serviceBehaviors> </behaviors> <extensions> <behaviorExtensions> <add name="enforceGreetingFaults" type="Microsoft.WCF.Documentation.EnforceGreetingFaultBehavior, HostApplication, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null" /> </behaviorExtensions> </extensions> </system.serviceModel> </configuration>
Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.