Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

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

Note: This method is new in the .NET Framework version 2.0.

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 method 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
)
J# does not support APIs that consume or return unsafe types.
JScript does not support APIs that consume or return unsafe types.

Parameters

bytes

A pointer to the first byte to decode.

byteCount

The number of bytes to decode.

chars

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

charCount

The maximum number of characters to write.

flush

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

Return Value

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

Exception typeCondition

ArgumentNullException

bytes is a null reference (Nothing in Visual Basic).

-or-

chars is a null reference (Nothing in Visual Basic).

ArgumentOutOfRangeException

byteCount or charCount is less than zero.

ArgumentException

charCount is less than the resulting number of characters.

To calculate the exact array size that GetChars required to store the resulting characters, use GetCharCount.

If GetChars is called with flush set to false, trailing bytes at the end of the data block are stored in an internal buffer and used in the next decoding operation. 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 GetChars is called with flush set to true, invalid bytes at the end of the data block are ignored and the internal buffer is cleared.

This method affects the state of the decoder.

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, 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.

.NET Framework

Supported in: 2.0

.NET Compact Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2015 Microsoft