EnvelopingSignatureWriter Constructor

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

Initializes an instance of T:Microsoft.IdentityModel.Protocols.XmlSignature.EnvelopingSignatureWriter. The returned writer is setup correctly to start writing the XML.

Namespace: Microsoft.IdentityModel.Protocols.XmlSignature
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim innerWriter As XmlWriter
Dim signingCredentials As SigningCredentials
Dim objectId As String
Dim securityTokenSerializer As SecurityTokenSerializer

Dim instance As New EnvelopingSignatureWriter(innerWriter, signingCredentials, objectId, securityTokenSerializer)

Syntax

'Declaration
Public Sub New ( _
    innerWriter As XmlWriter, _
    signingCredentials As SigningCredentials, _
    objectId As String, _
    securityTokenSerializer As SecurityTokenSerializer _
)
public EnvelopingSignatureWriter (
    XmlWriter innerWriter,
    SigningCredentials signingCredentials,
    string objectId,
    SecurityTokenSerializer securityTokenSerializer
)
public:
EnvelopingSignatureWriter (
    XmlWriter^ innerWriter, 
    SigningCredentials^ signingCredentials, 
    String^ objectId, 
    SecurityTokenSerializer^ securityTokenSerializer
)
public EnvelopingSignatureWriter (
    XmlWriter innerWriter, 
    SigningCredentials signingCredentials, 
    String objectId, 
    SecurityTokenSerializer securityTokenSerializer
)
public function EnvelopingSignatureWriter (
    innerWriter : XmlWriter, 
    signingCredentials : SigningCredentials, 
    objectId : String, 
    securityTokenSerializer : SecurityTokenSerializer
)

Parameters

  • innerWriter
    Writer to wrap.
  • signingCredentials
    SigningCredentials to be used to generate the signature.
  • objectId
    The reference Id of the envelope.
  • securityTokenSerializer
    TokenSerializer to serialize the signature KeyInfo.

Exceptions

Exception type Condition
ArgumentNullException

One of he input parameter is null.

ArgumentException

The string 'objectId' is either null or empty.

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)

See Also

Reference

EnvelopingSignatureWriter Class
EnvelopingSignatureWriter Members
Microsoft.IdentityModel.Protocols.XmlSignature Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.