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

Captures the XML source data from an EnvelopedSignatureReader.

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

Usage

'Usage
Dim instance As Saml2Assertion
Dim reader As EnvelopedSignatureReader

instance.CaptureSourceData(reader)

Syntax

'Declaration
Public Overridable Sub CaptureSourceData ( _
    reader As EnvelopedSignatureReader _
)

public virtual void CaptureSourceData (
    EnvelopedSignatureReader reader
)

public:
virtual void CaptureSourceData (
    EnvelopedSignatureReader^ reader
)

public void CaptureSourceData (
    EnvelopedSignatureReader reader
)

public function CaptureSourceData (
    reader : EnvelopedSignatureReader
)

Parameters

reader
The EnvelopedSignatureReader that was used to read the data for this assertion.

Exceptions

Exception type	Condition
ArgumentNullException	reader is null.

Remarks

The EnvelopedSignatureReader that is being used to read the data for this assertion should be passed to this method after the </Assertion> element has been read. This method preserves the raw XML data that is read, including the signature, so that it may be re-emitted without changes and without the need to re-sign the data. For more information, see the CanWriteSourceData property and the WriteSourceData method.

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)