SessionSecurityTokenCookieSerializer.ReadClaims 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 Claims from a XmlDictionaryReader and adds them to a ClaimCollection.

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

Usage

'Usage
Dim dictionaryReader As XmlDictionaryReader
Dim dictionary As SessionDictionary
Dim claims As ClaimCollection

Me.ReadClaims(dictionaryReader, dictionary, claims)

Syntax

'Declaration
Protected Overridable Sub ReadClaims ( _
    dictionaryReader As XmlDictionaryReader, _
    dictionary As SessionDictionary, _
    claims As ClaimCollection _
)

protected virtual void ReadClaims (
    XmlDictionaryReader dictionaryReader,
    SessionDictionary dictionary,
    ClaimCollection claims
)

protected:
virtual void ReadClaims (
    XmlDictionaryReader^ dictionaryReader, 
    SessionDictionary^ dictionary, 
    ClaimCollection^ claims
)

protected void ReadClaims (
    XmlDictionaryReader dictionaryReader, 
    SessionDictionary dictionary, 
    ClaimCollection claims
)

protected function ReadClaims (
    dictionaryReader : XmlDictionaryReader, 
    dictionary : SessionDictionary, 
    claims : ClaimCollection
)

Parameters

dictionaryReader
XmlDictionaryReader positioned at dictionary.Claim.

dictionary
SessionDictionary to provide dictionary strings.

claims
ClaimCollection to add the claims to.

Exceptions

Exception type	Condition
ArgumentNullException	The input argument 'dictionaryReader', 'dictionary' or 'claims' is null.

Remarks

Reads 'n' claims and adds them to claims.

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)