SessionSecurityTokenCookieSerializer.WritePrincipal 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 out a IClaimsPrincipal using a XmlDictionaryWriter.

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

Usage

'Usage
Dim dictionaryWriter As XmlDictionaryWriter
Dim dictionary As SessionDictionary
Dim principal As IClaimsPrincipal

Me.WritePrincipal(dictionaryWriter, dictionary, principal)

Syntax

'Declaration
Protected Overridable Sub WritePrincipal ( _
    dictionaryWriter As XmlDictionaryWriter, _
    dictionary As SessionDictionary, _
    principal As IClaimsPrincipal _
)

protected virtual void WritePrincipal (
    XmlDictionaryWriter dictionaryWriter,
    SessionDictionary dictionary,
    IClaimsPrincipal principal
)

protected:
virtual void WritePrincipal (
    XmlDictionaryWriter^ dictionaryWriter, 
    SessionDictionary^ dictionary, 
    IClaimsPrincipal^ principal
)

protected void WritePrincipal (
    XmlDictionaryWriter dictionaryWriter, 
    SessionDictionary dictionary, 
    IClaimsPrincipal principal
)

protected function WritePrincipal (
    dictionaryWriter : XmlDictionaryWriter, 
    dictionary : SessionDictionary, 
    principal : IClaimsPrincipal
)

Parameters

dictionaryWriter
XmlDictionaryWriter to write to.

dictionary
SessionDictionary to provide dictionary strings.

principal
IClaimsPrincipal to write.

Exceptions

Exception type	Condition
ArgumentNullException	The input argument 'dictionaryWriter', 'dictionary' or 'principal' 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