Saml2SecurityTokenHandler.ReadAdvice Method

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Reads the <saml:Advice> element.

Namespace: Microsoft.IdentityModel.Tokens.Saml2
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim reader As XmlReader
Dim returnValue As Saml2Advice

returnValue = Me.ReadAdvice(reader)

Syntax

'Declaration
Protected Overridable Function ReadAdvice ( _
    reader As XmlReader _
) As Saml2Advice
protected virtual Saml2Advice ReadAdvice (
    XmlReader reader
)
protected:
virtual Saml2Advice^ ReadAdvice (
    XmlReader^ reader
)
protected Saml2Advice ReadAdvice (
    XmlReader reader
)
protected function ReadAdvice (
    reader : XmlReader
) : Saml2Advice

Parameters

  • reader
    An XmlReader positioned at the element to read.

Return Value

A Saml2Advice that represents the Advice element that is read.

Exceptions

Exception type Condition
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.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)

See Also

Reference

Saml2SecurityTokenHandler Class
Saml2SecurityTokenHandler Members
Microsoft.IdentityModel.Tokens.Saml2 Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.