UserNameSecurityTokenHandler.ReadToken Method

[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 UsernameSecurityToken from the given XmlReader.

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


Dim instance As UserNameSecurityTokenHandler
Dim reader As XmlReader
Dim returnValue As SecurityToken

returnValue = instance.ReadToken(reader)


Public Overrides Function ReadToken ( _
    reader As XmlReader _
) As SecurityToken
public override SecurityToken ReadToken (
    XmlReader reader
virtual SecurityToken^ ReadToken (
    XmlReader^ reader
) override
public SecurityToken ReadToken (
    XmlReader reader
public override function ReadToken (
    reader : XmlReader
) : SecurityToken


  • reader
    XmlReader pointing to the SecurityToken.

Return Value

An instance of UserNameSecurityToken.


Exception type Condition

The parameter 'reader' is null.


The token cannot be read.


The Password was not in plain text format.


An unknown element was found in the SecurityToken or the username was not specified.

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.


Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)

See Also


UserNameSecurityTokenHandler Class
UserNameSecurityTokenHandler Members
Microsoft.IdentityModel.Tokens Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.