Encoding.GetBytes Method (String, Int32, Int32, Byte[], Int32)
Assembly: mscorlib (in mscorlib.dll)
public: virtual int GetBytes ( String^ s, int charIndex, int charCount, array<unsigned char>^ bytes, int byteIndex )
public int GetBytes ( String s, int charIndex, int charCount, byte[] bytes, int byteIndex )
public function GetBytes ( s : String, charIndex : int, charCount : int, bytes : byte[], byteIndex : int ) : int
Parameters
- s
The String containing the set of characters to encode.
- charIndex
The index of the first character to encode.
- charCount
The number of characters to encode.
- bytes
The byte array to contain the resulting sequence of bytes.
- byteIndex
The index at which to start writing the resulting sequence of bytes.
Return Value
The actual number of bytes written into bytes.| Exception type | Condition |
|---|---|
| s is a null reference (Nothing in Visual Basic). -or- bytes is a null reference (Nothing in Visual Basic). | |
| charIndex or charCount or byteIndex is less than zero. -or- charIndex and charCount do not denote a valid range in chars. -or- byteIndex is not a valid index in bytes. | |
| bytes does not have enough capacity from byteIndex to the end of the array to accommodate the resulting bytes. |
To calculate the exact array size required by GetBytes to store the resulting bytes, use GetByteCount. To calculate the maximum array size, use GetMaxByteCount. The GetByteCount method generally allows you to allocate less memory, whereas the GetMaxByteCount method generally executes faster.
If the data to be converted is available only in sequential blocks (such as data read from a stream) or if the amount of data is so large that it needs to be divided into smaller blocks, use the Decoder or the Encoder provided by the GetDecoder method or the GetEncoder method, respectively, of a derived class.
The following code example determines the number of bytes required to encode a string or a range in the string, encodes the characters, and displays the resulting bytes.
using namespace System; using namespace System::Text; void PrintCountsAndBytes( String^ s, Encoding^ enc ); void PrintCountsAndBytes( String^ s, int index, int count, Encoding^ enc ); void PrintHexBytes( array<Byte>^bytes ); int main() { // The characters to encode: // Latin Small Letter Z (U+007A) // Latin Small Letter A (U+0061) // Combining Breve (U+0306) // Latin Small Letter AE With Acute (U+01FD) // Greek Small Letter Beta (U+03B2) // a high-surrogate value (U+D8FF) // a low-surrogate value (U+DCFF) String^ myStr = L"za\u0306\u01FD\u03B2\xD8FF\xDCFF"; // Get different encodings. Encoding^ u7 = Encoding::UTF7; Encoding^ u8 = Encoding::UTF8; Encoding^ u16LE = Encoding::Unicode; Encoding^ u16BE = Encoding::BigEndianUnicode; Encoding^ u32 = Encoding::UTF32; // Encode the entire string, and print out the counts and the resulting bytes. Console::WriteLine( "Encoding the entire string:" ); PrintCountsAndBytes( myStr, u7 ); PrintCountsAndBytes( myStr, u8 ); PrintCountsAndBytes( myStr, u16LE ); PrintCountsAndBytes( myStr, u16BE ); PrintCountsAndBytes( myStr, u32 ); Console::WriteLine(); // Encode three characters starting at index 4, and print out the counts and the resulting bytes. Console::WriteLine( "Encoding the characters from index 4 through 6:" ); PrintCountsAndBytes( myStr, 4, 3, u7 ); PrintCountsAndBytes( myStr, 4, 3, u8 ); PrintCountsAndBytes( myStr, 4, 3, u16LE ); PrintCountsAndBytes( myStr, 4, 3, u16BE ); PrintCountsAndBytes( myStr, 4, 3, u32 ); } void PrintCountsAndBytes( String^ s, Encoding^ enc ) { // Display the name of the encoding used. Console::Write( "{0,-30} :", enc ); // Display the exact byte count. int iBC = enc->GetByteCount( s ); Console::Write( " {0,-3}", iBC ); // Display the maximum byte count. int iMBC = enc->GetMaxByteCount( s->Length ); Console::Write( " {0,-3} :", iMBC ); // Encode the entire string. array<Byte>^bytes = enc->GetBytes( s ); // Display all the encoded bytes. PrintHexBytes( bytes ); } void PrintCountsAndBytes( String^ s, int index, int count, Encoding^ enc ) { // Display the name of the encoding used. Console::Write( "{0,-30} :", enc ); // Display the exact byte count. int iBC = enc->GetByteCount( s->ToCharArray(), index, count ); Console::Write( " {0,-3}", iBC ); // Display the maximum byte count. int iMBC = enc->GetMaxByteCount( count ); Console::Write( " {0,-3} :", iMBC ); // Encode a range of characters in the string. array<Byte>^bytes = gcnew array<Byte>(iBC); enc->GetBytes( s, index, count, bytes, bytes->GetLowerBound( 0 ) ); // Display all the encoded bytes. PrintHexBytes( bytes ); } void PrintHexBytes( array<Byte>^bytes ) { if ( (bytes == nullptr) || (bytes->Length == 0) ) Console::WriteLine( "<none>" ); else { for ( int i = 0; i < bytes->Length; i++ ) Console::Write( "{0:X2} ", bytes[ i ] ); Console::WriteLine(); } } /* This code produces the following output. Encoding the entire string: System.Text.UTF7Encoding : 18 23 :7A 61 2B 41 77 59 42 2F 51 4F 79 32 50 2F 63 2F 77 2D System.Text.UTF8Encoding : 12 24 :7A 61 CC 86 C7 BD CE B2 F1 8F B3 BF System.Text.UnicodeEncoding : 14 16 :7A 00 61 00 06 03 FD 01 B2 03 FF D8 FF DC System.Text.UnicodeEncoding : 14 16 :00 7A 00 61 03 06 01 FD 03 B2 D8 FF DC FF System.Text.UTF32Encoding : 24 32 :7A 00 00 00 61 00 00 00 06 03 00 00 FD 01 00 00 B2 03 00 00 FF FC 04 00 Encoding the characters from index 4 through 6: System.Text.UTF7Encoding : 10 11 :2B 41 37 4C 59 2F 39 7A 2F 2D System.Text.UTF8Encoding : 6 12 :CE B2 F1 8F B3 BF System.Text.UnicodeEncoding : 6 8 :B2 03 FF D8 FF DC System.Text.UnicodeEncoding : 6 8 :03 B2 D8 FF DC FF System.Text.UTF32Encoding : 8 16 :B2 03 00 00 FF FC 04 00 */
import System.*;
import System.Text.*;
public class SamplesEncoding
{
public static void main(String[] args)
{
// The characters to encode:
// Latin Small Letter Z (U+007A)
// Latin Small Letter A (U+0061)
// Combining Breve (U+0306)
// Latin Small Letter AE With Acute (U+01FD)
// Greek Small Letter Beta (U+03B2)
// a high-surrogate value (U+D8FF)
// a low-surrogate value (U+DCFF)
String myStr = "za\u0306\u01FD\u03B2\uD8FF\uDCFF";
// Get different encodings.
Encoding u7 = Encoding.get_UTF7();
Encoding u8 = Encoding.get_UTF8();
Encoding u16LE = Encoding.get_Unicode();
Encoding u16BE = Encoding.get_BigEndianUnicode();
Encoding u32 = Encoding.get_UTF32();
// Encode the entire string, and print out the counts
// and the resulting bytes.
Console.WriteLine("Encoding the entire string:");
PrintCountsAndBytes(myStr, u7);
PrintCountsAndBytes(myStr, u8);
PrintCountsAndBytes(myStr, u16LE);
PrintCountsAndBytes(myStr, u16BE);
PrintCountsAndBytes(myStr, u32);
Console.WriteLine();
// Encode three characters starting at index 4,
// and print out the counts and the resulting bytes.
Console.WriteLine("Encoding the characters from index 4 through 6:");
PrintCountsAndBytes(myStr, 4, 3, u7);
PrintCountsAndBytes(myStr, 4, 3, u8);
PrintCountsAndBytes(myStr, 4, 3, u16LE);
PrintCountsAndBytes(myStr, 4, 3, u16BE);
PrintCountsAndBytes(myStr, 4, 3, u32);
} //main
public static void PrintCountsAndBytes(String s, Encoding enc)
{
// Display the name of the encoding used.
Console.Write("{0,-30} :", enc.ToString());
// Display the exact byte count.
int iBC = enc.GetByteCount(s);
Console.Write(" {0,-3}", String.valueOf(iBC));
// Display the maximum byte count.
int iMBC = enc.GetMaxByteCount(s.get_Length());
Console.Write(" {0,-3} :", String.valueOf(iMBC));
// Encode the entire string.
ubyte bytes[] = enc.GetBytes(s);
// Display all the encoded bytes.
PrintHexBytes(bytes);
} //PrintCountsAndBytes
public static void PrintCountsAndBytes(String s, int index,
int count, Encoding enc)
{
// Display the name of the encoding used.
Console.Write("{0,-30} :", enc.ToString());
// Display the exact byte count.
int iBC = enc.GetByteCount(s.ToCharArray(), index, count);
Console.Write(" {0,-3}", String.valueOf(iBC));
// Display the maximum byte count.
int iMBC = enc.GetMaxByteCount(count);
Console.Write(" {0,-3} :", String.valueOf(iMBC));
// Encode a range of characters in the string.
ubyte bytes[] = new ubyte[iBC];
enc.GetBytes(s, index, count, bytes, bytes.GetLowerBound(0));
// Display all the encoded bytes.
PrintHexBytes(bytes);
} //PrintCountsAndBytes
public static void PrintHexBytes(ubyte[] bytes)
{
if(bytes == null || bytes.length == 0) {
Console.WriteLine("<none>");
}
else {
for(int i = 0; i < bytes.length; i++) {
Console.Write("{0:X2} ",
((System.Byte)bytes[i]).ToString("X2"));
}
Console.WriteLine();
}
} //PrintHexBytes
} //SamplesEncoding
/*
This code produces the following output.
Encoding the entire string:
System.Text.UTF7Encoding : 18 23 :7A 61 2B 41 77 59 42 2F 51 4F 79 32 50
2F 63 2F 77 2D
System.Text.UTF8Encoding : 12 24 :7A 61 CC 86 C7 BD CE B2 F1 8F B3 BF
System.Text.UnicodeEncoding : 14 16 :7A 00 61 00 06 03 FD 01 B2 03 FF D8 FF
DC
System.Text.UnicodeEncoding : 14 16 :00 7A 00 61 03 06 01 FD 03 B2 D8 FF DC
FF
System.Text.UTF32Encoding : 24 32 :7A 00 00 00 61 00 00 00 06 03 00 00 FD
01 00 00 B2 03 00 00 FF FC 04 00
Encoding the characters from index 4 through 6:
System.Text.UTF7Encoding : 10 11 :2B 41 37 4C 59 2F 39 7A 2F 2D
System.Text.UTF8Encoding : 6 12 :CE B2 F1 8F B3 BF
System.Text.UnicodeEncoding : 6 8 :B2 03 FF D8 FF DC
System.Text.UnicodeEncoding : 6 8 :03 B2 D8 FF DC FF
System.Text.UTF32Encoding : 8 16 :B2 03 00 00 FF FC 04 00
*/
Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.