Saml2SecurityTokenHandler.CreateAdvice Method

Article
10/05/2012

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

Creates a Saml2Advice object for the assertion.

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

Usage

'Usage
Dim tokenDescriptor As SecurityTokenDescriptor
Dim returnValue As Saml2Advice

returnValue = Me.CreateAdvice(tokenDescriptor)

Syntax

'Declaration
Protected Overridable Function CreateAdvice ( _
    tokenDescriptor As SecurityTokenDescriptor _
) As Saml2Advice

protected virtual Saml2Advice CreateAdvice (
    SecurityTokenDescriptor tokenDescriptor
)

protected:
virtual Saml2Advice^ CreateAdvice (
    SecurityTokenDescriptor^ tokenDescriptor
)

protected Saml2Advice CreateAdvice (
    SecurityTokenDescriptor tokenDescriptor
)

protected function CreateAdvice (
    tokenDescriptor : SecurityTokenDescriptor
) : Saml2Advice

Parameters

tokenDescriptor
The token descriptor.

Return Value

A Saml2Advice object. The default is null.

Remarks

By default, this method returns null.

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