SessionAuthenticationModule.TryReadSessionTokenFromCookie Method

Reference

Definition

Namespace:: System.IdentityModel.Services

Assembly:: System.IdentityModel.Services.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Attempts to read a SessionSecurityToken from a session cookie and returns a value that indicates whether the session cookie was successfully read.

public:
 bool TryReadSessionTokenFromCookie([Runtime::InteropServices::Out] System::IdentityModel::Tokens::SessionSecurityToken ^ % sessionToken);

public bool TryReadSessionTokenFromCookie (out System.IdentityModel.Tokens.SessionSecurityToken sessionToken);

member this.TryReadSessionTokenFromCookie : SessionSecurityToken -> bool

Public Function TryReadSessionTokenFromCookie (ByRef sessionToken As SessionSecurityToken) As Boolean

Parameters

sessionToken: SessionSecurityToken

When this method returns, contains the session security token that was read from the session cookie.

Returns

Boolean

true if the session cookie was successfully read from the request; otherwise, false.

Remarks

Reads the cookie by using the cookie handler that is configured in the CookieHandler property and then invokes the ReadSessionTokenFromCookie method to read the token from the cookie.

Applies to