SessionAuthenticationModule.ReadSessionTokenFromCookie 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.]

Reads a SessionSecurityToken from a session cookie.

Namespace: Microsoft.IdentityModel.Web
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim instance As SessionAuthenticationModule
Dim sessionCookie As Byte()
Dim returnValue As SessionSecurityToken

returnValue = instance.ReadSessionTokenFromCookie(sessionCookie)

Syntax

'Declaration
Public Function ReadSessionTokenFromCookie ( _
    sessionCookie As Byte() _
) As SessionSecurityToken

public SessionSecurityToken ReadSessionTokenFromCookie (
    byte[] sessionCookie
)

public:
SessionSecurityToken^ ReadSessionTokenFromCookie (
    array<unsigned char>^ sessionCookie
)

public SessionSecurityToken ReadSessionTokenFromCookie (
    byte[] sessionCookie
)

public function ReadSessionTokenFromCookie (
    sessionCookie : byte[]
) : SessionSecurityToken

Parameters

sessionCookie
The cookie in raw form which contains the session token.

Return Value

The SessionSecurityToken read from the cookie.

Exceptions

Exception type	Condition
InvalidOperationException	No SessionSecurityTokenHandler in ServiceConfiguration.SecurityTokenHandlers.

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)