Export (0) Print
Expand All

AspNetCompatibilityRequirementsMode Enumeration

Specifies whether a Windows Communication Foundation (WCF) service runs, or can run, in a mode that is compatible with ASP.NET.

Namespace:  System.ServiceModel.Activation
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

Public Enumeration AspNetCompatibilityRequirementsMode

Member nameDescription
AllowedWCF services can run in an application domain with ASP.NET compatibility mode set to true or false.
NotAllowedWCF services must run in an application domain with ASP.NET compatibility mode set to false.
RequiredWCF services must run in an application domain with ASP.NET compatibility mode set to true.

ASP.NET compatibility mode allows WCF services to use ASP features such as identity impersonation. It is enabled at the application level through the Web.config file and cannot be overridden by Web.config files nested in the application. When the AspNetCompatibilityRequirementsMode value is not specified for a service, it gets Allowed behavior by default. For more information, see <serviceHostingEnvironment>.

Service developers can ensure that their service is only run in ASP.NET Compatibility Mode by setting the AspNetCompatibilityRequirementsMode property on the AspNetCompatibilityRequirementsAttribute to Required as shown in the following example:

<ServiceContract(Namespace:="http://Microsoft.ServiceModel.Samples")> _
Public Interface ICalculatorSession

    <OperationContract()> _
    Sub Clear()
    <OperationContract()> _
    Sub AddTo(ByVal n As Double)
    <OperationContract()> _
    Sub SubtractFrom(ByVal n As Double)
    <OperationContract()> _
    Sub MultiplyBy(ByVal n As Double)
    <OperationContract()> _
    Sub DivideBy(ByVal n As Double)
    <OperationContract()> _
    Function Equal() As Double 
End Interface
    <AspNetCompatibilityRequirements(RequirementsMode:=AspNetCompatibilityRequirementsMode.Required)> _
    Public Class CalculatorService
        Implements ICalculatorSession

        Property Result() As Double 
            ' Store result in AspNet Session. 
                If (HttpContext.Current.Session("Result") Is Nothing) Then 
                    Return 0D
                End If 
                Return HttpContext.Current.Session("Result")
            End Get 
            Set(ByVal value As Double)
                HttpContext.Current.Session("Result") = value
            End Set 
        End Property 

        Public Sub Clear() _
 Implements ICalculatorSession.Clear
            Result = 0D
        End Sub 

        Public Sub AddTo(ByVal n As Double) _
Implements ICalculatorSession.AddTo
            Result += n
        End Sub 

        Public Sub SubtractFrom(ByVal n As Double) _
Implements ICalculatorSession.SubtractFrom

            Result -= n
        End Sub 

        Public Sub MultiplyBy(ByVal n As Double) _
Implements ICalculatorSession.MultiplyBy

            Result *= n
        End Sub 

        Public Sub DivideBy(ByVal n As Double) _
Implements ICalculatorSession.DivideBy

            Result /= n
        End Sub 

        Public Function Equal() As Double _
Implements ICalculatorSession.Equal

            Return Result
        End Function 
    End Class

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

© 2014 Microsoft