Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

SoapFilterResult Class

Determines whether the processing pipeline should either, continue processing to the next filter, terminate processing or transfer processing to a user defined method.


Namespace: Microsoft.Web.Services3
Assembly: Microsoft.Web.Services3 (in microsoft.web.services3.dll)

VB
Copy 
'Usage
Dim targetMethod As SoapServerMethod
Dim soapFilterResult1 As New SoapFilterResult(targetMethod)
C#
C++
VB
Copy 
public sealed class SoapFilterResult
J#
Copy 
public final class SoapFilterResult
JScript
Copy 
public class SoapFilterResult

A SoapFilterResult that is returned from the ProcessMessage method can be used to communicate whether processing must proceed to the next Soap filter in the pipeline, or whether processing should terminate.

A SoapFilterResult should be used to communicate the intent of pipeline processing. A SoapFilter should return Continue if it wants processing to continue to the next Soap filter or return Terminate if it wants processing to terminate.

A SoapFilterResult can also be used to instruct the pipeline to run a user defined method instead of running the next soap filter while processing incoming messages. This is done by creating a new SoapFilterResult by using the SoapFilterResult constructor.

The behavior of the pipeline and its interpretation of the SoapFilterResult returned from ProcessMessage depends on whether the Soap filter is an input filter, or an output filter. In the case of an input filter that processes incoming messages, if the ProcessMessage returns Continue processing will continue to the next filter in the pipeline. However, if this filter returns a SoapFilterResult containing a user defined SoapServerMethod then processing of the pipeline will be transferred to this user defined method, and then terminated.

If a Soap filter is an output filter that processes outgoing messages and ProcessMessage returns Terminate, processing will stop, and the next filter in the pipeline will not be executed.


System.Object
  Microsoft.Web.Services3.SoapFilterResult
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows 2000, Windows 2000 Server, Windows 2000 Advanced Server

Target Platforms

Did you find this helpful?
(1500 characters remaining)