Saml2SecurityTokenHandler.ReadAdvice(XmlReader) Method

Reference

Definition

Namespace:: System.IdentityModel.Tokens

Assembly:: System.IdentityModel.dll

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.

Reads the <saml:Advice> element.

protected:
 virtual System::IdentityModel::Tokens::Saml2Advice ^ ReadAdvice(System::Xml::XmlReader ^ reader);

protected virtual System.IdentityModel.Tokens.Saml2Advice ReadAdvice (System.Xml.XmlReader reader);

abstract member ReadAdvice : System.Xml.XmlReader -> System.IdentityModel.Tokens.Saml2Advice
override this.ReadAdvice : System.Xml.XmlReader -> System.IdentityModel.Tokens.Saml2Advice

Protected Overridable Function ReadAdvice (reader As XmlReader) As Saml2Advice

Parameters

reader: XmlReader

An XmlReader positioned at the element to read.

Returns

Saml2Advice

A Saml2Advice that represents the Advice element that is read.

Exceptions

ArgumentNullException

reader is null.

Remarks

The Advice element has an extensibility point to allow XML elements from non-SAML 2.0 namespaces to be included. By default, because the Advice may be ignored without affecting the semantics of the assertion, any such elements are ignored. To handle the processing of those elements, override this method.

Applies to

Jaa