SessionSecurityTokenHandler.WriteToken Method (SessionSecurityToken)

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

Writes the token into a byte array.

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

Usage

'Usage
Dim instance As SessionSecurityTokenHandler
Dim sessionToken As SessionSecurityToken
Dim returnValue As Byte()

returnValue = instance.WriteToken(sessionToken)

Syntax

'Declaration
Public Overridable Function WriteToken ( _
    sessionToken As SessionSecurityToken _
) As Byte()

public virtual byte[] WriteToken (
    SessionSecurityToken sessionToken
)

public:
virtual array<unsigned char>^ WriteToken (
    SessionSecurityToken^ sessionToken
)

public byte[] WriteToken (
    SessionSecurityToken sessionToken
)

public function WriteToken (
    sessionToken : SessionSecurityToken
) : byte[]

Parameters

sessionToken
The SessionSecurityToken to write.

Return Value

An encoded byte array.

Exceptions

Exception type	Condition
ArgumentNullException	Thrown if 'sessiontoken' is 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