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

Determines if a session cookie is in the provided cookie collection.

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

Usage

'Usage
Dim instance As SessionAuthenticationModule
Dim httpCookieCollection As HttpCookieCollection
Dim returnValue As Boolean

returnValue = instance.ContainsSessionTokenCookie(httpCookieCollection)

Syntax

'Declaration
Public Function ContainsSessionTokenCookie ( _
    httpCookieCollection As HttpCookieCollection _
) As Boolean

public bool ContainsSessionTokenCookie (
    HttpCookieCollection httpCookieCollection
)

public:
bool ContainsSessionTokenCookie (
    HttpCookieCollection^ httpCookieCollection
)

public boolean ContainsSessionTokenCookie (
    HttpCookieCollection httpCookieCollection
)

public function ContainsSessionTokenCookie (
    httpCookieCollection : HttpCookieCollection
) : boolean

Parameters

httpCookieCollection
The collection of cookies to look in.

Return Value

true if a session cookie is found; otherwise, false.

Exceptions

Exception type	Condition
ArgumentNullException	if httpCookieCollection is null

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)