SecurityTokenHandlerCollection.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 representation of a token can be read by one of the handlers in this collection.

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

public bool CanReadToken(
	string tokenString
)

Parameters

tokenString
Type: System.String

The token represented as a string.

Return Value

Type: System.Boolean

true if the collection contains a token handler that can read the specified token; otherwise false.

Exception Condition
ArgumentNullException

tokenString is null or an empty string.

The method invokes the SecurityTokenHandler.CanReadToken(String) method on the token handlers (SecurityTokenHandler) in the collection to determine whether the token can be read.

.NET Framework
Available since 4.5
Return to top
Show: