WSTrustServiceContract.HandleException Method

Article
10/05/2012

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Raises the RequestFailed event and converts the specified exception to a FaultException if required. If the original exception was a FaultException or if the PreserveOriginalException flag is set to true, the conversion to FaultException is not performed.

Namespace: Microsoft.IdentityModel.Protocols.WSTrust
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim ex As Exception
Dim trustNamespace As String
Dim action As String
Dim requestEnvelopeVersion As EnvelopeVersion
Dim returnValue As Boolean

returnValue = Me.HandleException(ex, trustNamespace, action, requestEnvelopeVersion)

Syntax

'Declaration
Protected Overridable Function HandleException ( _
    ex As Exception, _
    trustNamespace As String, _
    action As String, _
    requestEnvelopeVersion As EnvelopeVersion _
) As Boolean

protected virtual bool HandleException (
    Exception ex,
    string trustNamespace,
    string action,
    EnvelopeVersion requestEnvelopeVersion
)

protected:
virtual bool HandleException (
    Exception^ ex, 
    String^ trustNamespace, 
    String^ action, 
    EnvelopeVersion^ requestEnvelopeVersion
)

protected boolean HandleException (
    Exception ex, 
    String trustNamespace, 
    String action, 
    EnvelopeVersion requestEnvelopeVersion
)

protected function HandleException (
    ex : Exception, 
    trustNamespace : String, 
    action : String, 
    requestEnvelopeVersion : EnvelopeVersion
) : boolean

Parameters

ex
The original exception.

trustNamespace
The namespace of the current WS-Trust version.

action
The WS-Trust action that caused the exception.

requestEnvelopeVersion
The SOAP version of the request envelope.

Return Value

Returns Boolean. false if the original exception is thrown.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)

Share via