Decoder.GetChars Метод

Определение

Пространство имен:

System.Text

Сборка:

System.Runtime.dll

При переопределении в производном классе декодирует последовательность байтов в набор символов.

Перегрузки

GetChars(ReadOnlySpan<Byte>, Span<Char>, Boolean)	При переопределении в производном классе декодирует последовательность байтов диапазона и все байты во внутреннем буфере в набор символов, которые хранятся начиная с указанного указателя символов. Параметр указывает, следует ли очистить внутреннее состояние декодера после преобразования.
GetChars(Byte*, Int32, Char*, Int32, Boolean)	При переопределении в производном классе декодирует последовательность байтов, начиная с указанного указателя байтов, и все байты во внутреннем буфере в набор символов, хранящихся начиная с указанного указателя символов. Параметр указывает, следует ли очистить внутреннее состояние декодера после преобразования.
GetChars(Byte[], Int32, Int32, Char[], Int32)	При переопределении в производном классе декодирует последовательность байтов из указанного массива байтов и всех байтов во внутреннем буфере в указанный массив символов.
GetChars(Byte[], Int32, Int32, Char[], Int32, Boolean)	При переопределении в производном классе декодирует последовательность байтов из указанного массива байтов и всех байтов во внутреннем буфере в указанный массив символов. Параметр указывает, следует ли очистить внутреннее состояние декодера после преобразования.

GetChars(ReadOnlySpan<Byte>, Span<Char>, Boolean)

Исходный код:

Decoder.cs

При переопределении в производном классе декодирует последовательность байтов диапазона и все байты во внутреннем буфере в набор символов, которые хранятся начиная с указанного указателя символов. Параметр указывает, следует ли очистить внутреннее состояние декодера после преобразования.

public:
 virtual int GetChars(ReadOnlySpan<System::Byte> bytes, Span<char> chars, bool flush);

public virtual int GetChars (ReadOnlySpan<byte> bytes, Span<char> chars, bool flush);

abstract member GetChars : ReadOnlySpan<byte> * Span<char> * bool -> int
override this.GetChars : ReadOnlySpan<byte> * Span<char> * bool -> int

Public Overridable Function GetChars (bytes As ReadOnlySpan(Of Byte), chars As Span(Of Char), flush As Boolean) As Integer

Параметры

bytes

ReadOnlySpan<Byte>

Диапазон байтов для декодации.

chars

Span<Char>

Диапазон для записи результирующего набора символов.

flush

Boolean

true очистить внутреннее состояние декодера после преобразования; в противном случае false.

Возвращаемое значение

Int32

Фактическое число символов, записанных в диапазоне, указанное параметром chars.

Комментарии

Помните, что объект Decoder сохраняет состояние между вызовами GetChars. Когда приложение выполняется с потоком данных, оно должно задать параметр flush для true, чтобы убедиться, что сведения о состоянии сбрасываются. С помощью этого параметра декодировщик игнорирует недопустимые байты в конце блока данных и очищает внутренний буфер.

Чтобы вычислить точный размер диапазона, который GetChars требуется для хранения полученных символов, приложение должно использовать GetCharCount.

Если GetChars вызывается с flush для false, декодатор сохраняет конечные байты в конце блока данных во внутреннем буфере и использует их в следующей операции декодирования. Приложение должно вызывать GetCharCount в блоке данных непосредственно перед вызовом GetChars в одном блоке, чтобы все конечные байты из предыдущего блока были включены в вычисление.

Если приложение предназначено для преобразования множества сегментов входного потока, рассмотрите возможность использования метода Convert. GetChars вызовет исключение, если выходной диапазон не достаточно велик, но Convert заполняет максимальное пространство и возвращает байты чтения и записи символов, если выходной массив позволяет по крайней мере два символа. Дополнительные комментарии см. в разделе Encoding.GetChars.

GetChars(Byte*, Int32, Char*, Int32, Boolean)

Исходный код:

Decoder.cs

Важно!

Этот API несовместим с CLS.

При переопределении в производном классе декодирует последовательность байтов, начиная с указанного указателя байтов, и все байты во внутреннем буфере в набор символов, хранящихся начиная с указанного указателя символов. Параметр указывает, следует ли очистить внутреннее состояние декодера после преобразования.

public:
 virtual int GetChars(System::Byte* bytes, int byteCount, char* chars, int charCount, bool flush);

[System.CLSCompliant(false)]
public virtual int GetChars (byte* bytes, int byteCount, char* chars, int charCount, bool flush);

[<System.CLSCompliant(false)>]
abstract member GetChars : nativeptr<byte> * int * nativeptr<char> * int * bool -> int
override this.GetChars : nativeptr<byte> * int * nativeptr<char> * int * bool -> int

Параметры

bytes

Byte*

Указатель на первый байт для декодации.

byteCount

Int32

Количество байтов, которые необходимо декодировать.

chars

Char*

Указатель на расположение, с которого начинается запись результирующего набора символов.

charCount

Int32

Максимальное количество символов для записи.

flush

Boolean

true очистить внутреннее состояние декодера после преобразования; в противном случае false.

Возвращаемое значение

Int32

Фактическое число символов, записанных в расположении, указанном параметром chars.

Атрибуты

CLSCompliantAttribute

Исключения

ArgumentNullException

bytes null (Nothing).

-или-

chars null (Nothing).

ArgumentOutOfRangeException

byteCount или charCount меньше нуля.

ArgumentException

charCount меньше результирующего числа символов.

DecoderFallbackException

Произошла резервная ошибка (дополнительные сведения см. в разделе Кодировка символов в .NET)

-и-

Fallback имеет значение DecoderExceptionFallback.

Комментарии

Помните, что объект Decoder сохраняет состояние между вызовами GetChars. Когда приложение выполняется с потоком данных, оно должно задать параметр flush для true, чтобы убедиться, что сведения о состоянии сбрасываются. С помощью этого параметра декодировщик игнорирует недопустимые байты в конце блока данных и очищает внутренний буфер.

Чтобы вычислить точный размер буфера, который GetChars требуется для хранения полученных символов, приложение должно использовать GetCharCount.

Если GetChars вызывается с flush для false, декодатор сохраняет конечные байты в конце блока данных во внутреннем буфере и использует их в следующей операции декодирования. Приложение должно вызывать GetCharCount в блоке данных непосредственно перед вызовом GetChars в одном блоке, чтобы все конечные байты из предыдущего блока были включены в вычисление.

Если приложение предназначено для преобразования множества сегментов входного потока, рассмотрите возможность использования метода Convert. GetChars вызовет исключение, если выходной буфер недостаточно велик, но Convert заполняет максимальное пространство и возвращает записанные байты, если выходной массив позволяет по крайней мере два символа. Дополнительные комментарии см. в разделе Encoding.GetChars.

См. также раздел

• GetCharCount(Byte*, Int32, Boolean)
• Reset()

GetChars(Byte[], Int32, Int32, Char[], Int32)

Исходный код:

Decoder.cs

При переопределении в производном классе декодирует последовательность байтов из указанного массива байтов и всех байтов во внутреннем буфере в указанный массив символов.

public:
 abstract int GetChars(cli::array <System::Byte> ^ bytes, int byteIndex, int byteCount, cli::array <char> ^ chars, int charIndex);

public abstract int GetChars (byte[] bytes, int byteIndex, int byteCount, char[] chars, int charIndex);

abstract member GetChars : byte[] * int * int * char[] * int -> int

Public MustOverride Function GetChars (bytes As Byte(), byteIndex As Integer, byteCount As Integer, chars As Char(), charIndex As Integer) As Integer

Параметры

bytes

Byte[]

Массив байтов, содержащий последовательность байтов для декодирования.

byteIndex

Int32

Индекс первого байта для декодирования.

byteCount

Int32

Количество байтов, которые необходимо декодировать.

chars

Char[]

Массив символов, содержащий результирующий набор символов.

charIndex

Int32

Индекс, с которого начинается запись результирующего набора символов.

Возвращаемое значение

Int32

Фактическое число символов, записанных в chars.

Исключения

ArgumentNullException

bytes null (Nothing).

-или-

chars null (Nothing).

ArgumentOutOfRangeException

byteIndex или byteCount или charIndex меньше нуля.

-или-

byteindex и byteCount не указывают допустимый диапазон в bytes.

-или-

charIndex недопустимый индекс в chars.

ArgumentException

chars не хватает емкости от charIndex до конца массива, чтобы разместить полученные символы.

DecoderFallbackException

Произошла резервная ошибка (дополнительные сведения см. в разделе Кодировка символов в .NET)

-и-

Fallback имеет значение DecoderExceptionFallback.

Примеры

В следующем примере показано, как декодировать диапазон элементов из массива байтов и хранить их в массиве символов Юникода. Метод GetCharCount используется для вычисления количества символов, необходимых для хранения декодированных элементов в массиве bytes. Метод GetChars декодирует указанные элементы в массиве байтов и сохраняет их в новом массиве символов.

using namespace System;
using namespace System::Text;
using namespace System::Collections;
int main()
{
   array<Char>^chars;
   array<Byte>^bytes = {85,0,110,0,105,0,99,0,111,0,100,0,101,0};
   Decoder^ uniDecoder = Encoding::Unicode->GetDecoder();
   int charCount = uniDecoder->GetCharCount( bytes, 0, bytes->Length );
   chars = gcnew array<Char>(charCount);
   int charsDecodedCount = uniDecoder->GetChars( bytes, 0, bytes->Length, 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();
}

/* This code example produces the following output.

7 characters used to decode bytes.
Decoded chars: [U][n][i][c][o][d][e]

*/

using System;
using System.Text;

class UnicodeEncodingExample {
    public static void Main() {
        Char[] chars;
        Byte[] bytes = new Byte[] {
            85, 0, 110, 0, 105, 0, 99, 0, 111, 0, 100, 0, 101, 0
        };

        Decoder uniDecoder = Encoding.Unicode.GetDecoder();

        int charCount = uniDecoder.GetCharCount(bytes, 0, bytes.Length);
        chars = new Char[charCount];
        int charsDecodedCount = uniDecoder.GetChars(bytes, 0, bytes.Length, chars, 0);

        Console.WriteLine(
            "{0} characters used to decode bytes.", charsDecodedCount
        );

        Console.Write("Decoded chars: ");
        foreach (Char c in chars) {
            Console.Write("[{0}]", c);
        }
        Console.WriteLine();
    }
}

/* This code example produces the following output.

7 characters used to decode bytes.
Decoded chars: [U][n][i][c][o][d][e]

*/

Imports System.Text

Class UnicodeEncodingExample
    
    Public Shared Sub Main()
        Dim chars() As Char
        Dim bytes() As Byte = { _
            85, 0, 110, 0, 105, 0, 99, 0, 111, 0, 100, 0, 101, 0 _
        }
        
        Dim uniDecoder As Decoder = Encoding.Unicode.GetDecoder()
        
        Dim charCount As Integer = uniDecoder.GetCharCount(bytes, 0, bytes.Length)
        chars = New Char(charCount - 1) {}
        Dim charsDecodedCount As Integer = _
            uniDecoder.GetChars(bytes, 0, bytes.Length, chars, 0)
        
        Console.WriteLine( _
            "{0} characters used to decode bytes.", _
            charsDecodedCount _
        )
        
        Console.Write("Decoded chars: ")
        Dim c As Char
        For Each c In  chars
            Console.Write("[{0}]", c)
        Next c
        Console.WriteLine()
    End Sub
End Class

'This code example produces the following output.
'
'7 characters used to decode bytes.
'Decoded chars: [U][n][i][c][o][d][e]
'

Комментарии

Помните, что объект Decoder сохраняет состояние между вызовами GetChars. Когда приложение выполняется с потоком данных, оно должно задать параметр flush для true, чтобы убедиться, что сведения о состоянии сбрасываются. С помощью этого параметра декодировщик игнорирует недопустимые байты в конце блока данных и очищает внутренний буфер.

Чтобы вычислить точный размер массива, который GetChars требуется для хранения полученных символов, приложение должно использовать GetCharCount.

Если GetChars вызывается с flush для false, декодатор сохраняет конечные байты в конце блока данных во внутреннем буфере и использует их в следующей операции декодирования. Приложение должно вызывать GetCharCount в блоке данных непосредственно перед вызовом GetChars в одном блоке, чтобы все конечные байты из предыдущего блока были включены в вычисление.

Если приложение предназначено для преобразования множества сегментов входного потока, рассмотрите возможность использования метода Convert. GetChars вызовет исключение, если выходной буфер недостаточно велик, но Convert заполняет максимальное пространство и возвращает записанные байты, если выходной массив позволяет по крайней мере два символа. Дополнительные комментарии см. в разделе Encoding.GetChars.

См. также раздел

• GetCharCount(Byte[], Int32, Int32)
• Reset()

GetChars(Byte[], Int32, Int32, Char[], Int32, Boolean)

Исходный код:

Decoder.cs

При переопределении в производном классе декодирует последовательность байтов из указанного массива байтов и всех байтов во внутреннем буфере в указанный массив символов. Параметр указывает, следует ли очистить внутреннее состояние декодера после преобразования.

public:
 virtual int GetChars(cli::array <System::Byte> ^ bytes, int byteIndex, int byteCount, cli::array <char> ^ chars, int charIndex, bool flush);

public virtual int GetChars (byte[] bytes, int byteIndex, int byteCount, char[] chars, int charIndex, bool flush);

abstract member GetChars : byte[] * int * int * char[] * int * bool -> int
override this.GetChars : byte[] * int * int * char[] * int * bool -> int

Public Overridable Function GetChars (bytes As Byte(), byteIndex As Integer, byteCount As Integer, chars As Char(), charIndex As Integer, flush As Boolean) As Integer

Параметры

bytes

Byte[]

Массив байтов, содержащий последовательность байтов для декодирования.

byteIndex

Int32

Индекс первого байта для декодирования.

byteCount

Int32

Количество байтов, которые необходимо декодировать.

chars

Char[]

Массив символов, содержащий результирующий набор символов.

charIndex

Int32

Индекс, с которого начинается запись результирующего набора символов.

flush

Boolean

true очистить внутреннее состояние декодера после преобразования; в противном случае false.

Возвращаемое значение

Int32

Фактическое число символов, записанных в параметр chars.

Исключения

ArgumentNullException

bytes null (Nothing).

-или-

chars null (Nothing).

ArgumentOutOfRangeException

byteIndex или byteCount или charIndex меньше нуля.

-или-

byteindex и byteCount не указывают допустимый диапазон в bytes.

-или-

charIndex недопустимый индекс в chars.

ArgumentException

chars не хватает емкости от charIndex до конца массива, чтобы разместить полученные символы.

DecoderFallbackException

Произошла резервная ошибка (дополнительные сведения см. в разделе Кодировка символов в .NET)

-и-

Fallback имеет значение DecoderExceptionFallback.

Комментарии

Помните, что объект Decoder сохраняет состояние между вызовами GetChars. Когда приложение выполняется с потоком данных, оно должно задать параметр flush для true, чтобы убедиться, что сведения о состоянии сбрасываются. С помощью этого параметра декодировщик игнорирует недопустимые байты в конце блока данных и очищает внутренний буфер.

Чтобы вычислить точный размер массива, который GetChars требуется для хранения полученных символов, приложение должно использовать GetCharCount.

Если GetChars вызывается с flush для false, декодатор сохраняет конечные байты в конце блока данных во внутреннем буфере и использует их в следующей операции декодирования. Приложение должно вызывать GetCharCount в блоке данных непосредственно перед вызовом GetChars в одном блоке, чтобы все конечные байты из предыдущего блока были включены в вычисление.

Если приложение предназначено для преобразования множества сегментов входного потока, рассмотрите возможность использования метода Convert. GetChars вызовет исключение, если выходной буфер недостаточно велик, но Convert заполняет максимальное пространство и возвращает записанные байты, если выходной массив позволяет по крайней мере два символа. Дополнительные комментарии см. в разделе Encoding.GetChars.

См. также раздел

• GetCharCount(Byte[], Int32, Int32, Boolean)
• Reset()