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

Indicates the start of Canonicalization. Any write opertation following this will canonicalize the data and will wirte it to the given stream.

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

Usage

'Usage
Dim instance As DelegatingXmlDictionaryWriter
Dim stream As Stream
Dim includeComments As Boolean
Dim inclusivePrefixes As String()

instance.StartCanonicalization(stream, includeComments, inclusivePrefixes)

Syntax

'Declaration
Public Overrides Sub StartCanonicalization ( _
    stream As Stream, _
    includeComments As Boolean, _
    inclusivePrefixes As String() _
)

public override void StartCanonicalization (
    Stream stream,
    bool includeComments,
    string[] inclusivePrefixes
)

public:
virtual void StartCanonicalization (
    Stream^ stream, 
    bool includeComments, 
    array<String^>^ inclusivePrefixes
) override

public void StartCanonicalization (
    Stream stream, 
    boolean includeComments, 
    String[] inclusivePrefixes
)

public override function StartCanonicalization (
    stream : Stream, 
    includeComments : boolean, 
    inclusivePrefixes : String[]
)

Parameters

stream
Stream to which the canonical stream should be written.

includeComments
The value indicates if comments written should be canonicalized as well.

inclusivePrefixes
Set of prefixes that needs to be included into the canonical stream. The prefixes are defined at the first element that is written to the canonical stream.

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