SecurityTokenHandler.CanReadToken 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.]

Indicates whether the current XML element can be read as a token of the type handled by this instance.

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

Usage

'Usage
Dim instance As SecurityTokenHandler
Dim reader As XmlReader
Dim returnValue As Boolean

returnValue = instance.CanReadToken(reader)

Syntax

'Declaration
Public Overridable Function CanReadToken ( _
    reader As XmlReader _
) As Boolean

public virtual bool CanReadToken (
    XmlReader reader
)

public:
virtual bool CanReadToken (
    XmlReader^ reader
)

public boolean CanReadToken (
    XmlReader reader
)

public function CanReadToken (
    reader : XmlReader
) : boolean

Parameters

reader
An XML reader positioned at a start element. The reader should not be advanced.

Return Value

true if the ReadToken method can read the element; otherwise, false.

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)