Export (0) Print
Expand All

Encoding.GetChars Method (Byte*, Int32, Char*, Int32)

When overridden in a derived class, decodes a sequence of bytes starting at the specified byte pointer into a set of characters that are stored starting at the specified character pointer.

This method is not CLS-compliant.  

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

'Declaration

'Usage

Not applicable.

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.

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.

DecoderFallbackException

A fallback occurred (see Understanding Encodings for complete explanation)

-and-

DecoderFallback is set to DecoderExceptionFallback.

To calculate the exact array size that GetChars requires to store the resulting characters, the application should use GetCharCount. To calculate the maximum array size, the application should use GetMaxCharCount. The GetCharCount method generally allows allocation of less memory, while the GetMaxCharCount 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 object provided by the GetDecoder or the GetEncoder method, respectively, of a derived class.

Note   This method is intended to operate on Unicode characters, not on arbitrary binary data, such as byte arrays. If your application needs to encode arbitrary binary data into text, it should use a protocol such as uuencode, which is implemented by methods such as System.Convert.ToBase64CharArray.

For a discussion of programming considerations for use of this method, see the Encoding class description.

Windows 98, Windows Server 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 Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft