This documentation is archived and is not being maintained.

Encoding::Convert Method (Encoding, Encoding, array<Byte>)

Converts an entire byte array from one encoding to another.

Namespace:  System.Text
Assembly:  mscorlib (in mscorlib.dll)

public:
static array<unsigned char>^ Convert(
	Encoding^ srcEncoding, 
	Encoding^ dstEncoding, 
	array<unsigned char>^ bytes
)

Parameters

srcEncoding
Type: System.Text::Encoding

The encoding format of bytes.

dstEncoding
Type: System.Text::Encoding

The target encoding format.

bytes
Type: array<System::Byte>

Return Value

Type: array<System::Byte>
An array of type Byte containing the results of converting bytes from srcEncoding to dstEncoding.

ExceptionCondition
ArgumentNullException

srcEncoding is nullptr.

-or-

dstEncoding is nullptr.

-or-

bytes is nullptr.

DecoderFallbackException

A fallback occurred (see Understanding Encodings for complete explanation)

-and-

srcEncoding.DecoderFallback is set to DecoderExceptionFallback.

EncoderFallbackException

A fallback occurred (see Understanding Encodings for complete explanation)

-and-

dstEncoding.EncoderFallback is set to EncoderExceptionFallback.

The following example converts a Unicode-encoded string to an ASCII-encoded string. Because the ASCII encoding object returned by the ASCII property uses replacement fallback and the Pi character is not part of the ASCII character set, the Pi character is replaced with a question mark, as the output from the example shows.

using namespace System;
using namespace System::Text;

int main()
{
   String^ unicodeString = "This string contains the unicode character Pi (\u03a0)";

   // Create two different encodings.
   Encoding^ ascii = Encoding::ASCII;
   Encoding^ unicode = Encoding::Unicode;

   // Convert the string into a byte array. 
   array<Byte>^unicodeBytes = unicode->GetBytes( unicodeString );

   // Perform the conversion from one encoding to the other. 
   array<Byte>^asciiBytes = Encoding::Convert( unicode, ascii, unicodeBytes );

   // Convert the new Byte into[] a char and[] then into a string. 
   array<Char>^asciiChars = gcnew array<Char>(ascii->GetCharCount( asciiBytes, 0, asciiBytes->Length ));
   ascii->GetChars( asciiBytes, 0, asciiBytes->Length, asciiChars, 0 );
   String^ asciiString = gcnew String( asciiChars );

   // Display the strings created before and after the conversion.
   Console::WriteLine( "Original String*: {0}", unicodeString );
   Console::WriteLine( "Ascii converted String*: {0}", asciiString );
}
// The example displays the following output: 
//    Original string: This string contains the unicode character Pi (Π) 
//    Ascii converted string: This string contains the unicode character Pi (?)

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

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

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0

XNA Framework

Supported in: 3.0, 2.0, 1.0
Show: