DefaultTokenReplayCache.TryAdd 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.]

Attempt to add a SecurityToken.

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

Usage

'Usage
Dim instance As DefaultTokenReplayCache
Dim key As String
Dim securityToken As SecurityToken
Dim expirationTime As DateTime
Dim returnValue As Boolean

returnValue = instance.TryAdd(key, securityToken, expirationTime)

Syntax

'Declaration
Public Overrides Function TryAdd ( _
    key As String, _
    securityToken As SecurityToken, _
    expirationTime As DateTime _
) As Boolean

public override bool TryAdd (
    string key,
    SecurityToken securityToken,
    DateTime expirationTime
)

public:
virtual bool TryAdd (
    String^ key, 
    SecurityToken^ securityToken, 
    DateTime expirationTime
) override

public boolean TryAdd (
    String key, 
    SecurityToken securityToken, 
    DateTime expirationTime
)

public override function TryAdd (
    key : String, 
    securityToken : SecurityToken, 
    expirationTime : DateTime
) : boolean

Parameters

key
Key to use when adding item.

securityToken
SecurityToken to add to cache, can be null.

expirationTime
The expiration instant of the token being added.

Return Value

true if a SecurityToken was added, false if item was not added.

Exceptions

Exception type	Condition
QuotaExceededException	Thrown if an attempt is made to add a SecurityToken if cache is at capacity.
InvalidOperationException	Thrown if the expiration time is infinite.

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)

Share via