SecurityTokenHandler.CanReadKeyIdentifierClause(XmlReader) Method

Definition

Namespace:

System.IdentityModel.Tokens

Assembly:

System.IdentityModel.dll

Returns a value that indicates whether the XML element referred to by the specified XML reader is a key identifier clause that can be deserialized by this instance.

public:
 virtual bool CanReadKeyIdentifierClause(System::Xml::XmlReader ^ reader);

public virtual bool CanReadKeyIdentifierClause (System.Xml.XmlReader reader);

abstract member CanReadKeyIdentifierClause : System.Xml.XmlReader -> bool
override this.CanReadKeyIdentifierClause : System.Xml.XmlReader -> bool

Public Overridable Function CanReadKeyIdentifierClause (reader As XmlReader) As Boolean

Parameters

reader

XmlReader

An XML reader positioned at the start element. The reader should not be advanced by this method.

Returns

Boolean

true if the ReadKeyIdentifierClause(XmlReader) method can read the element; otherwise, false. The default is false.

Remarks

The default implementation returns false to indicate that the key identifier clause cannot be read.

A derived class checks the element that the reader is referring to in order to determine whether the instance can deserialize a key identifier clause. This is typically accomplished through a call to the XmlReader.IsStartElement method with the appropriate element and namespace strings specified. If you override CanReadKeyIdentifierClause, you must also override the ReadKeyIdentifierClause method to provide the logic to deserialize the key identifier clause.