Encoding.GetBytes Method (String, Int32, Int32, Byte, Int32)
When overridden in a derived class, encodes a set of characters from the specified string into the specified byte array.
Assembly: mscorlib (in mscorlib.dll)
abstract GetBytes : s:string * charIndex:int * charCount:int * bytes:byte * byteIndex:int -> int override GetBytes : s:string * charIndex:int * charCount:int * bytes:byte * byteIndex:int -> int
- Type: System.String
The string containing the set of characters to encode.
- Type: System.Int32
The index of the first character to encode.
- Type: System.Int32
The number of characters to encode.
- Type: System.Byte
The byte array to contain the resulting sequence of bytes.
- Type: System.Int32
The index at which to start writing the resulting sequence of bytes.
Return ValueType: System.Int32
The actual number of bytes written into bytes.
s is a null reference (Nothing in Visual Basic).
bytes is a null reference (Nothing in Visual Basic).
charIndex or charCount or byteIndex is less than zero.
charIndex and charCount do not denote a valid range in chars.
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.
A fallback occurred (see Character Encoding in the .NET Framework for complete explanation)
To calculate the exact array size required by GetBytes to store the resulting bytes, the application should use GetByteCount. To calculate the maximum array size, the application should use GetMaxByteCount. The GetByteCount method generally allows allocation of less memory, while 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, the application should use the Decoder or the Encoder provided by the GetDecoder method or the GetEncoder method, respectively, of a derived class.
The GetByteCount method determines how many bytes result in encoding a set of Unicode characters, and the GetBytes method performs the actual encoding. The Encoding.GetBytes method expects discrete conversions, in contrast to the Encoder.GetBytes method, which handles multiple conversions on a single input stream.
The application might need to encode many input characters to a code page and process the characters using multiple calls. In this case, your application probably needs to maintain state between calls, taking into account the state that is persisted by the Encoder object being used. (For example, a character sequence that includes surrogate pairs might end with a high surrogate. The Encoder will remember that high surrogate so that it can be combined with a low surrogate at the beginning of a following call. Encoding won't be able to maintain the state, so the character will be sent to the EncoderFallback.)
If the application handles string inputs, it is recommended to use the string version of GetBytes.
The Unicode character buffer version of GetBytes(Char*, Int32, Byte*, Int32) allows some fast techniques, particularly with multiple calls using the Encoder object or inserting into existing buffers. Bear in mind, however, that this method version is sometimes unsafe, since pointers are required.
If your application must convert a large amount of data, it should reuse the output buffer. In this case, the GetBytes version that supports byte arrays is the best choice.
Consider using the Encoder.Convert method instead of GetByteCount. The conversion method converts as much data as possible, and does throw an exception if the output buffer is too small. For continuous encoding of a stream, this method is often the best choice.
.NET FrameworkSupported in: 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0
.NET Framework Client ProfileSupported in: 4, 3.5 SP1
Portable Class LibrarySupported in: Portable Class Library
.NET for Windows Store appsSupported in: Windows 8
.NET for Windows Phone appsSupported 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.