WebService.Session Property (System.Web.Services)

Session Property

.NET Framework Class Library

WebService..::.Session Property

Gets the HttpSessionState instance for the current request.

Namespace: System.Web.Services
Assembly: System.Web.Services (in System.Web.Services.dll)

Syntax

Visual Basic (Declaration)

<BrowsableAttribute(False)> _
Public ReadOnly Property Session As HttpSessionState

Visual Basic (Usage)

Dim instance As WebService
Dim value As HttpSessionState

value = instance.Session

[BrowsableAttribute(false)]
public HttpSessionState Session { get; }

Visual C++

[BrowsableAttribute(false)]
public:
property HttpSessionState^ Session {
    HttpSessionState^ get ();
}

JScript

public function get Session () : HttpSessionState

Property Value

Type: System.Web.SessionState..::.HttpSessionState
An HttpSessionState representing the ASP.NET session state object for the current session.

Examples

The example below uses session state to determine how many times a particular session accesses the XML Web service method SessionHitCounter. In this example, the EnableSession property of the WebMethodAttribute is set to true in order to gain access to session state.

Visual Basic

<%@ WebService Language="VB" Class="Util" %>

Imports System.Web.Services

Public Class Util
    Inherits WebService

    <WebMethod(Description := "Per session Hit Counter", _
        EnableSession := True)> _
    Public Function SessionHitCounter() As Integer

        If Session("HitCounter") Is Nothing Then
            Session("HitCounter") = 1
        Else
            Session("HitCounter") = CInt(Session("HitCounter")) + 1
        End If
        Return CInt(Session("HitCounter"))
    End Function
End Class

<%@ WebService Language="C#" Class="Util" %>

 using System.Web.Services;

 public class Util: WebService {
   [ WebMethod(Description="Per session Hit Counter",EnableSession=true)]
    public int SessionHitCounter() {
       if (Session["HitCounter"] == null) {
          Session["HitCounter"] = 1;
       }
       else {
          Session["HitCounter"] = ((int) Session["HitCounter"]) + 1;
          }
       return ((int) Session["HitCounter"]);
    }   
 }

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

Reference

WebService Class

WebService Members

System.Web.Services Namespace

HttpSessionState