SecurityTokenHandler.CanReadToken Method (String)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns a value that indicates whether the specified string can be deserialized as a token of the type processed by this instance.

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

abstract CanReadToken : 
        tokenString:string -> bool
override CanReadToken : 
        tokenString:string -> bool

Parameters

tokenString
Type: System.String

The token string to read.

Return Value

Type: System.Boolean

true if the SecurityTokenHandler.ReadToken method can read the element; otherwise, false. The default is false.

The default implementation always returns false.

If you override this method, you must also override the SecurityTokenHandler.ReadToken method to provide the logic to deserialize the token.

.NET Framework
Available since 4.5
Return to top
Show: