UTF8Encoding::GetChars Method (array<Byte>^, Int32, Int32, array<Char>^, Int32)
Decodes a sequence of bytes from the specified byte array into the specified character array.
Assembly: mscorlib (in mscorlib.dll)
public: virtual int GetChars( array<unsigned char>^ bytes, int byteIndex, int byteCount, array<wchar_t>^ chars, int charIndex ) override
Parameters
- bytes
-
Type:
array<System::Byte>^
The byte array containing the sequence of bytes to decode.
- byteIndex
-
Type:
System::Int32
The index of the first byte to decode.
- byteCount
-
Type:
System::Int32
The number of bytes to decode.
- chars
-
Type:
array<System::Char>^
The character array to contain the resulting set of characters.
- charIndex
-
Type:
System::Int32
The index at which to start writing the resulting set of characters.
| Exception | Condition |
|---|---|
| ArgumentNullException | bytes is null. -or- chars is null. |
| ArgumentOutOfRangeException | byteIndex or byteCount or charIndex is less than zero. -or- byteindex and byteCount do not denote a valid range in bytes. -or- charIndex is not a valid index in chars. |
| ArgumentException | Error detection is enabled, and bytes contains an invalid sequence of bytes. -or- chars does not have enough capacity from charIndex to the end of the array to accommodate the resulting characters. |
| DecoderFallbackException | A fallback occurred (see Character Encoding in the .NET Framework for complete explanation) -and- DecoderFallback is set to DecoderExceptionFallback. |
To calculate the exact array size required by GetChars to store the resulting characters, call the GetCharCount method. To calculate the maximum array size, call the GetMaxCharCount method. The GetCharCount method generally allocates less memory, while the GetMaxCharCount method generally executes faster.
With error detection, an invalid sequence causes this method to throw an ArgumentException exception. Without error detection, invalid sequences are ignored, and no exception is thrown.
If the range of bytes to be decoded includes the byte order mark (BOM) and the byte array was returned by a method of a non-BOM aware type, the character U+FFFE is included in the character array returned by this method. You can remove it by calling the String::TrimStart method.
Data to be converted, such as data read from a stream, might be available only in sequential blocks. In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, use the Decoder or the Encoder provided by the GetDecoder method or the GetEncoder method, respectively.
The following example uses the GetChars method to decode a range of elements in a byte array and store the result in a character array.
using namespace System; using namespace System::Text; using namespace System::Collections; int main() { array<Char>^chars; array<Byte>^bytes = {85,84,70,56,32,69,110,99,111,100,105,110,103,32,69,120,97,109,112,108,101}; UTF8Encoding^ utf8 = gcnew UTF8Encoding; int charCount = utf8->GetCharCount( bytes, 2, 13 ); chars = gcnew array<Char>(charCount); int charsDecodedCount = utf8->GetChars( bytes, 2, 13, chars, 0 ); Console::WriteLine( "{0} characters used to decode bytes.", charsDecodedCount ); Console::Write( "Decoded chars: " ); IEnumerator^ myEnum = chars->GetEnumerator(); while ( myEnum->MoveNext() ) { Char c = safe_cast<Char>(myEnum->Current); Console::Write( "[{0}]", c.ToString() ); } Console::WriteLine(); }
Available since 8
.NET Framework
Available since 1.1
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1