Saml11SecurityTokenHandler.ReadAdvice Method

2012-10-05

[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.]

Read saml:Advice element from the given XmlReader.

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

Usage

'Usage
Dim reader As XmlReader
Dim returnValue As SamlAdvice

returnValue = Me.ReadAdvice(reader)

Syntax

'Declaration
Protected Overridable Function ReadAdvice ( _
    reader As XmlReader _
) As SamlAdvice

protected virtual SamlAdvice ReadAdvice (
    XmlReader reader
)

protected:
virtual SamlAdvice^ ReadAdvice (
    XmlReader^ reader
)

protected SamlAdvice ReadAdvice (
    XmlReader reader
)

protected function ReadAdvice (
    reader : XmlReader
) : SamlAdvice

Parameters

reader
XmlReader positioned at a SAML Advice element.

Return Value

SamlAdvice

Exceptions

Exception type	Condition
ArgumentNullException	Parameter 'reader' is null.
XmlException	The reder is not positioned at a saml:Advice element.

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)

Share via