X509SecurityTokenHandler.CanReadToken Method

Article
2012-10-05

[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.]

Checks if the reader points to a X.509 Security Token as defined in WS-Security.

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

Usage

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

returnValue = instance.CanReadToken(reader)

Syntax

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

public override bool CanReadToken (
    XmlReader reader
)

public:
virtual bool CanReadToken (
    XmlReader^ reader
) override

public boolean CanReadToken (
    XmlReader reader
)

public override function CanReadToken (
    reader : XmlReader
) : boolean

Parameters

reader
Reader pointing to the token XML.

Return Value

Returns true if the element is pointing to a X.509 Security Token.

Exceptions

Exception type	Condition
ArgumentNullException	The parameter 'reader' is null.

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)

Share via