This documentation is archived and is not being maintained.

AsymmetricAlgorithm.ToXmlString Method

When overridden in a derived class, creates and returns an XML string representation of the current AsymmetricAlgorithm object.

Namespace:  System.Security.Cryptography
Assembly:  mscorlib (in mscorlib.dll)

'Declaration
Public MustOverride Function ToXmlString ( _
	includePrivateParameters As Boolean _
) As String

Parameters

includePrivateParameters
Type: System.Boolean
true to include private parameters; otherwise, false.

Return Value

Type: System.String
An XML string encoding of the current AsymmetricAlgorithm object.

The following code example demonstrates how to call the ToXmlString method to create an XML representation of the parameters in the current AsymmetricAlgorithm object. This code example is part of a larger example provided for the AsymmetricAlgorithm class.


Public Overrides Function ToXmlString( _
    ByVal includePrivateParameters As Boolean) As String

    Dim keyContainerName As String = ""
    Dim keyNumber As String = ""
    Dim providerName As String = ""
    Dim providerType As String = ""

    If Not cspParameters Is Nothing Then
        keyContainerName = cspParameters.KeyContainerName
        keyNumber = cspParameters.KeyNumber.ToString()
        providerName = cspParameters.ProviderName
        providerType = cspParameters.ProviderType.ToString()
    End If

    Dim xmlBuilder As New StringBuilder
    xmlBuilder.Append("<CustomCryptoKeyValue>")

    xmlBuilder.Append("<KeyContainerName>")
    xmlBuilder.Append(keyContainerName)
    xmlBuilder.Append("</KeyContainerName>")

    xmlBuilder.Append("<KeyNumber>")
    xmlBuilder.Append(keyNumber)
    xmlBuilder.Append("</KeyNumber>")

    xmlBuilder.Append("<ProviderName>")
    xmlBuilder.Append(providerName)
    xmlBuilder.Append("</ProviderName>")

    xmlBuilder.Append("<ProviderType>")
    xmlBuilder.Append(providerType)
    xmlBuilder.Append("</ProviderType>")

    xmlBuilder.Append("</CustomCryptoKeyValue>")
    Return (xmlBuilder.ToString())
End Function


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: