SessionAuthenticationModule.TryReadSessionTokenFromCookie 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 and returns a value that indicates whether the session cookie was read.

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

Usage

'Usage
Dim instance As SessionAuthenticationModule
Dim sessionToken As SessionSecurityToken
Dim returnValue As Boolean

returnValue = instance.TryReadSessionTokenFromCookie(sessionToken)

Syntax

'Declaration
Public Function TryReadSessionTokenFromCookie ( _
    <OutAttribute> ByRef sessionToken As SessionSecurityToken _
) As Boolean

public bool TryReadSessionTokenFromCookie (
    out SessionSecurityToken sessionToken
)

public:
bool TryReadSessionTokenFromCookie (
    [OutAttribute] SessionSecurityToken^% sessionToken
)

public boolean TryReadSessionTokenFromCookie (
    /** @attribute OutAttribute() */ /** @ref */ SessionSecurityToken sessionToken
)

Parameters

sessionToken
When this method returns, contains the SessionSecurityToken read from the session cookie.

Return Value

true if the session cookie was read from the request; otherwise, 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

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)