Saml2Serializer.ReadAdvice(XmlDictionaryReader) Method

Definition

Reads the <saml:Advice> element.

protected virtual Microsoft.IdentityModel.Tokens.Saml2.Saml2Advice ReadAdvice (System.Xml.XmlDictionaryReader reader);
abstract member ReadAdvice : System.Xml.XmlDictionaryReader -> Microsoft.IdentityModel.Tokens.Saml2.Saml2Advice
override this.ReadAdvice : System.Xml.XmlDictionaryReader -> Microsoft.IdentityModel.Tokens.Saml2.Saml2Advice
Protected Overridable Function ReadAdvice (reader As XmlDictionaryReader) As Saml2Advice

Parameters

reader
XmlDictionaryReader

A XmlReader positioned at a Saml2Advice element.

Returns

A Saml2Advice instance.

Exceptions

If reader is null.

If reader is not positioned at a Saml2Advice.

Remarks

The Advice element has an extensibility point to allow XML elements from non-SAML2 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