Saml11SecurityTokenHandler.GetCacheExpirationTime 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.]

Returns the time until which the token should be held in the token replay cache.

Namespace: Microsoft.IdentityModel.Tokens.Saml11
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim token As SamlSecurityToken
Dim returnValue As DateTime

returnValue = Me.GetCacheExpirationTime(token)

Syntax

'Declaration
Protected Overridable Function GetCacheExpirationTime ( _
    token As SamlSecurityToken _
) As DateTime

protected virtual DateTime GetCacheExpirationTime (
    SamlSecurityToken token
)

protected:
virtual DateTime GetCacheExpirationTime (
    SamlSecurityToken^ token
)

protected DateTime GetCacheExpirationTime (
    SamlSecurityToken token
)

protected function GetCacheExpirationTime (
    token : SamlSecurityToken
) : DateTime

Parameters

token
The token to return an expiration time for.

Return Value

A DateTime representing the expiration time.

Exceptions

Exception type	Condition
ArgumentNullException	The input argument 'token' 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)