AsymmetricAlgorithm.ToXmlString(Boolean) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
When overridden in a derived class, creates and returns an XML string representation of the current AsymmetricAlgorithm object. Otherwise, throws a NotImplementedException.
public:
virtual System::String ^ ToXmlString(bool includePrivateParameters);
public:
abstract System::String ^ ToXmlString(bool includePrivateParameters);
public virtual string ToXmlString (bool includePrivateParameters);
public abstract string ToXmlString (bool includePrivateParameters);
abstract member ToXmlString : bool -> string
override this.ToXmlString : bool -> string
abstract member ToXmlString : bool -> string
Public Overridable Function ToXmlString (includePrivateParameters As Boolean) As String
Public MustOverride Function ToXmlString (includePrivateParameters As Boolean) As String
Parameters
- includePrivateParameters
- Boolean
true
to include private parameters; otherwise, false
.
Returns
An XML string encoding of the current AsymmetricAlgorithm object.
Examples
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:
virtual String^ ToXmlString(bool includePrivateParameters) override
{
String^ keyContainerName = "";
String^ keyNumber = "";
String^ providerName = "";
String^ providerType = "";
if (cryptoServiceParameters != nullptr)
{
keyContainerName =
cryptoServiceParameters->KeyContainerName;
keyNumber = cryptoServiceParameters->KeyNumber.ToString();
providerName = cryptoServiceParameters->ProviderName;
providerType =
cryptoServiceParameters->ProviderType.ToString();
}
StringBuilder^ sb = gcnew StringBuilder();
sb->Append("<CustomCryptoKeyValue>");
sb->Append("<KeyContainerName>");
sb->Append(keyContainerName);
sb->Append("</KeyContainerName>");
sb->Append("<KeyNumber>");
sb->Append(keyNumber);
sb->Append("</KeyNumber>");
sb->Append("<ProviderName>");
sb->Append(providerName);
sb->Append("</ProviderName>");
sb->Append("<ProviderType>");
sb->Append(providerType);
sb->Append("</ProviderType>");
sb->Append("</CustomCryptoKeyValue>");
return(sb->ToString());
}
public override string ToXmlString(bool includePrivateParameters)
{
string keyContainerName = "";
string keyNumber = "";
string providerName = "";
string providerType = "";
if (cspParameters != null)
{
keyContainerName = cspParameters.KeyContainerName;
keyNumber = cspParameters.KeyNumber.ToString();
providerName = cspParameters.ProviderName;
providerType = cspParameters.ProviderType.ToString();
}
StringBuilder sb = new StringBuilder();
sb.Append("<CustomCryptoKeyValue>");
sb.Append("<KeyContainerName>");
sb.Append(keyContainerName);
sb.Append("</KeyContainerName>");
sb.Append("<KeyNumber>");
sb.Append(keyNumber);
sb.Append("</KeyNumber>");
sb.Append("<ProviderName>");
sb.Append(providerName);
sb.Append("</ProviderName>");
sb.Append("<ProviderType>");
sb.Append(providerType);
sb.Append("</ProviderType>");
sb.Append("</CustomCryptoKeyValue>");
return(sb.ToString());
}
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