EncryptedSecurityTokenHandler.WriteToken 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.]

Writes a EncryptedSecurityToken using the xmlWriter.

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

Usage

'Usage
Dim instance As EncryptedSecurityTokenHandler
Dim writer As XmlWriter
Dim token As SecurityToken

instance.WriteToken(writer, token)

Syntax

'Declaration
Public Overrides Sub WriteToken ( _
    writer As XmlWriter, _
    token As SecurityToken _
)

public override void WriteToken (
    XmlWriter writer,
    SecurityToken token
)

public:
virtual void WriteToken (
    XmlWriter^ writer, 
    SecurityToken^ token
) override

public void WriteToken (
    XmlWriter writer, 
    SecurityToken token
)

public override function WriteToken (
    writer : XmlWriter, 
    token : SecurityToken
)

Parameters

writer
The XmlWriter to which the encrypted token is written.

token
The SecurityToken which must be an instance of EncryptedSecurityToken.

Exceptions

Exception type	Condition
ArgumentNullException	The input prameter 'writer' is null. -or- The input prameter 'token' is null.
ArgumentException	The SecurityToken is not an instance of EncryptedSecurityToken.
InvalidOperationException	The property 'Configuration' is null. This property is required for obtaining keys for encryption. -or- The ContaingCollection was unable to find a SecurityTokenHandler that is able to write the SecurityToken returned by 'EncryptedSecurityToken.Token'.
SecurityTokenException	The property 'EncryptinCredentials.SecurityKey is not a SymmetricSecurityKey

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)