Saml2SecurityTokenHandler.ReadSubject 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 the <saml:Subject> element.

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

Usage

'Usage
Dim reader As XmlReader
Dim returnValue As Saml2Subject

returnValue = Me.ReadSubject(reader)

Syntax

'Declaration
Protected Overridable Function ReadSubject ( _
    reader As XmlReader _
) As Saml2Subject

protected virtual Saml2Subject ReadSubject (
    XmlReader reader
)

protected:
virtual Saml2Subject^ ReadSubject (
    XmlReader^ reader
)

protected Saml2Subject ReadSubject (
    XmlReader reader
)

protected function ReadSubject (
    reader : XmlReader
) : Saml2Subject

Parameters

reader
An XmlReader positioned at the element to read.

Return Value

A Saml2Subject that represents the Subject element that was read.

Exceptions

Exception type	Condition
ArgumentNullException	reader is null.

Remarks

The default implementation does not handle the optional <EncryptedID> element. To handle encryped IDs in the Subject, override this method.

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)