SoapInputFilter.CanProcessHeader Method

Article
09/15/2006
2 minutes to read

Determines whether the specified header can be processed by the filter.

Namespace: Microsoft.Web.Services2
Assembly: Microsoft.Web.Services2 (in microsoft.web.services2.dll)

Usage

'Usage
Public Class soapInputFilterImplementation
    Inherits SoapInputFilter
        Protected Overrides Function CanProcessHeader(header As XmlElement, _
            context As SoapContext)
            MyBase.CanProcessHeader(header, context)
        End Function
End Class

Syntax

'Declaration
Protected Overridable Function CanProcessHeader( _
    ByVal header As XmlElement, _
    ByVal context As SoapContext _
) As Boolean

protected virtual bool CanProcessHeader(
    XmlElement header, 
    SoapContext context
);

protected: Boolean CanProcessHeader(
    XmlElement^ header, 
    SoapContext^ context
);

protected boolean CanProcessHeader(
    XmlElement header, 
    SoapContext context
);

protected function CanProcessHeader(
     header : XmlElement, 
     context : SoapContext
) : Boolean;

Parameters

header
A System.Xml.XmlElement containing the header.

context
A SoapContext containing message-specific data.

Return Value

true if the specified header can be processed by the filter; otherwise, false .

Exceptions

Exception type	Condition
System.ArgumentNullException	headeris null. -or- contextis null.

System.ArgumentNullException

headeris null.

-or-

contextis null.

Remarks

The header can be processed if any of the following conditions are true:

Actor is equal to ActorNext.
Actor matches this node.
Actor is empty and the IsIntermediary property of context is false .

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

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows Longhorn, and Windows 2000

Target Platforms

Windows 2000, Windows 2000 Server, Windows 2000 Advanced Server, Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows Longhorn, Pocket PC, Windows CE, Smart Phone