Export (0) Print
Expand All

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)

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


Type: System.Text::Encoding

The encoding format of bytes.

Type: System.Text::Encoding

The target encoding format.

Type: array<System::Byte>

The bytes to convert.

Return Value

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


srcEncoding is nullptr.


dstEncoding is nullptr.


bytes is nullptr.


A fallback occurred (see Character Encoding in the .NET Framework for complete explanation)


srcEncoding.DecoderFallback is set to DecoderExceptionFallback.


A fallback occurred (see Character Encoding in the .NET Framework for complete explanation)


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 (?)

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

© 2014 Microsoft