Export (0) Print
Expand All

Decoder.GetChars Method (Byte*, Int32, Char*, Int32, Boolean)

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

This API is not CLS-compliant. 

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

[CLSCompliantAttribute(false)]
[ComVisibleAttribute(false)]
public virtual int GetChars(
	byte* bytes,
	int byteCount,
	char* chars,
	int charCount,
	bool flush
)

Parameters

bytes
Type: System.Byte*

A pointer to the first byte to decode.

byteCount
Type: System.Int32

The number of bytes to decode.

chars
Type: System.Char*

A pointer to the location at which to start writing the resulting set of characters.

charCount
Type: System.Int32

The maximum number of characters to write.

flush
Type: System.Boolean

true to clear the internal state of the decoder after the conversion; otherwise, false.

Return Value

Type: System.Int32
The actual number of characters written at the location indicated by the chars parameter.

ExceptionCondition
ArgumentNullException

bytes is null (Nothing).

-or-

chars is null (Nothing).

ArgumentOutOfRangeException

byteCount or charCount is less than zero.

ArgumentException

charCount is less than the resulting number of characters.

DecoderFallbackException

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

-and-

Fallback is set to DecoderExceptionFallback.

Remember that the Decoder object saves state between calls to GetChars. When the application is done with a stream of data, it should set the flush parameter to true to make sure that the state information is flushed. With this setting, the decoder ignores invalid bytes at the end of the data block and clears the internal buffer.

To calculate the exact buffer size that GetChars requires to store the resulting characters, the application should use GetCharCount.

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

If your application is to convert many segments of an input stream, consider using the Convert method. GetChars will throw an exception if the output buffer isn't large enough, but Convert will fill as much space as possible and return the bytes read and chars written. Also see the Encoding.GetChars topic for more comments.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Phone apps

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

  • SecurityCriticalAttribute 

    Requires full trust for the immediate caller. This member cannot be used by partially trusted or transparent code.

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.

Show:
© 2014 Microsoft