SessionSecurityTokenCookieSerializer.ReadClaimProperties 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 ClaimProperties from a XmlDictionaryReader and adds them to a Dictionary.

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

Usage

'Usage
Dim dictionaryReader As XmlDictionaryReader
Dim dictionary As SessionDictionary
Dim properties As IDictionary(Of String, String)

Me.ReadClaimProperties(dictionaryReader, dictionary, properties)

Syntax

'Declaration
Protected Overridable Sub ReadClaimProperties ( _
    dictionaryReader As XmlDictionaryReader, _
    dictionary As SessionDictionary, _
    properties As IDictionary(Of String, String) _
)

protected virtual void ReadClaimProperties (
    XmlDictionaryReader dictionaryReader,
    SessionDictionary dictionary,
    IDictionary<string,string> properties
)

protected:
virtual void ReadClaimProperties (
    XmlDictionaryReader^ dictionaryReader, 
    SessionDictionary^ dictionary, 
    IDictionary<String^, String^>^ properties
)

protected void ReadClaimProperties (
    XmlDictionaryReader dictionaryReader, 
    SessionDictionary dictionary, 
    IDictionary<String,String> properties
)

protected function ReadClaimProperties (
    dictionaryReader : XmlDictionaryReader, 
    dictionary : SessionDictionary, 
    properties : IDictionary<String,String>
)

Parameters

dictionaryReader
XmlDictionaryReader positioned at the element dictionary.ClaimProperties

dictionary
SessionDictionary to provide dictionary strings.

properties
Dictionary to add properties to.

Exceptions

Exception type	Condition
ArgumentNullException	The input argument 'dictionaryReader', 'dictionary' or 'properties' is null.
SecurityTokenException	Is thrown if the 'name' of a property is null or an empty string. -or- Is thrown if the 'value' of a property is null.

ArgumentNullException

The input argument 'dictionaryReader', 'dictionary' or 'properties' is null.

SecurityTokenException

Is thrown if the 'name' of a property is null or an empty string.

-or-

Is thrown if the 'value' of a property is null.

Remarks

Reads 'n' properties.

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)