SecurityTokenResolver.TryResolveSecurityKey Method

Reference

Definition

Namespace:: System.IdentityModel.Selectors

Assembly:: System.IdentityModel.dll

Source:: SecurityTokenResolver.cs

Source:: SecurityTokenResolver.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Attempts to retrieve the key that is referenced in the specified key identifier clause.

public:
 bool TryResolveSecurityKey(System::IdentityModel::Tokens::SecurityKeyIdentifierClause ^ keyIdentifierClause, [Runtime::InteropServices::Out] System::IdentityModel::Tokens::SecurityKey ^ % key);

public bool TryResolveSecurityKey(System.IdentityModel.Tokens.SecurityKeyIdentifierClause keyIdentifierClause, out System.IdentityModel.Tokens.SecurityKey key);

member this.TryResolveSecurityKey : System.IdentityModel.Tokens.SecurityKeyIdentifierClause * SecurityKey -> bool

Public Function TryResolveSecurityKey (keyIdentifierClause As SecurityKeyIdentifierClause, ByRef key As SecurityKey) As Boolean

Parameters

keyIdentifierClause: SecurityKeyIdentifierClause

A SecurityKeyIdentifierClause to retrieve the key for.

key: SecurityKey

When this method returns, contains a SecurityKey that contains the key that is referenced in the specified key identifier clause. This parameter is passed uninitialized.

Returns

Boolean

true when a key can be retrieved for the specified key identifier clause; otherwise, false.

Exceptions

ArgumentNullException

keyIdentifierClause is null.

Remarks

The TryResolveSecurityKey and ResolveSecurityKey methods differ in what happens when the key identifier clause cannot be resolved to a key. The TryResolveSecurityKey method returns false, whereas the ResolveSecurityKey method throws an exception.

Applies to

Product	Versions
.NET Framework	3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Share via