SecurityTokenResolver.TryResolveSecurityKey Method

Definition

Namespace:

System.IdentityModel.Selectors

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v6.2.0

Source:

SecurityTokenResolver.cs

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.