System.Text.Encoder.GetBytes Method

When overridden in a derived class, encodes a set of characters starting at the specified character pointer and any characters in the internal buffer into a sequence of bytes that are stored starting at the specified byte pointer. A parameter indicates whether to clear the internal state of the encoder after the conversion.

Syntax

[System.CLSCompliant(false)]
[System.Runtime.InteropServices.ComVisible(false)]
public virtual int GetBytes (char* chars, int charCount, byte* bytes, int byteCount, bool flush)

Parameters

chars
A pointer to the first character to encode.
charCount
The number of characters to encode.
bytes
A pointer to the location at which to start writing the resulting sequence of bytes.
byteCount
The maximum number of bytes to write.
flush
true to clear the internal state of the encoder after the conversion; otherwise, false.

Returns

The actual number of bytes written at the location indicated by the bytes parameter.

Remarks

Remember that the System.Text.Encoder object saves state between calls to Encoder.GetBytes(Char*, int, Byte*, int, bool). When the application is done with a stream of data, it should set the flush parameter to true in the last call to GetBytes to make sure that the state information is flushed and that the encoded bytes are properly terminated. With this setting, the encoder ignores invalid bytes at the end of the data block, such as unmatched surrogates or incomplete combining sequences, and clears the internal buffer.

To calculate the exact buffer size that GetBytes requires to store the resulting characters, the application should use Encoder.GetByteCount(Char*, int, bool).

If GetBytes is called with flush set to false, the encoder stores trailing bytes at the end of the data block in an internal buffer and uses them in the next encoding operation. The application should call GetByteCount on a block of data immediately before calling GetBytes on the same block, so that any trailing characters from the previous block are included in the calculation.

If your application is to convert many segments of an input stream, consider using the Encoder.Convert(Char*, int, Byte*, int, bool, Int32@, Int32@, Boolean@) method. Encoder.GetBytes(Char*, int, Byte*, int, bool) will throw an exception if the output buffer isn't large enough, but Encoder.Convert(Char*, int, Byte*, int, bool, Int32@, Int32@, Boolean@) will fill as much space as possible and return the chars read and bytes written. Also see the Encoding.GetBytes(Char*, int, Byte*, int) topic for more comments.

Requirements

Namespace: System.Text
Assembly: mscorlib (in mscorlib.dll)
Assembly Versions: 2.0.0.0, 4.0.0.0
Since: .NET 2.0