Saml2SecurityTokenHandler.WriteSigningKeyInfo 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 the Signing <ds:KeyInfo> element using the specified XML writer.

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

Usage

'Usage
Dim writer As XmlWriter
Dim signingKeyIdentifier As SecurityKeyIdentifier

Me.WriteSigningKeyInfo(writer, signingKeyIdentifier)

Syntax

'Declaration
Protected Overridable Sub WriteSigningKeyInfo ( _
    writer As XmlWriter, _
    signingKeyIdentifier As SecurityKeyIdentifier _
)

protected virtual void WriteSigningKeyInfo (
    XmlWriter writer,
    SecurityKeyIdentifier signingKeyIdentifier
)

protected:
virtual void WriteSigningKeyInfo (
    XmlWriter^ writer, 
    SecurityKeyIdentifier^ signingKeyIdentifier
)

protected void WriteSigningKeyInfo (
    XmlWriter writer, 
    SecurityKeyIdentifier signingKeyIdentifier
)

protected function WriteSigningKeyInfo (
    writer : XmlWriter, 
    signingKeyIdentifier : SecurityKeyIdentifier
)

Parameters

writer
The XmlWriter with which to serialize the key identifier.

signingKeyIdentifier
The SecurityKeyIdentifier that represents the key identifier to write.

Exceptions

Exception type	Condition
ArgumentNullException	signingKeyIdentifier is null. -or- writer is null.
InvalidOperationException	The handler cannot serialize the key identifier specified by signingKeyIdentifier.

ArgumentNullException

signingKeyIdentifier is null.

-or-

writer is null.

InvalidOperationException

The handler cannot serialize the key identifier specified by signingKeyIdentifier.

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)