Encoder.GetBytes Метод

Определение

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

System.Text

Сборки:

netstandard.dll, System.Runtime.dll

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

Перегрузки

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

Комментарии

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

Чтобы вычислить точный размер буфера, необходимый GetBytes для хранения результирующего символа, приложение должно использовать GetByteCount.

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

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

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

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

Encoder.cs

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

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

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

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

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

Параметры

chars

ReadOnlySpan<Char>

Диапазон символов для кодирования.

bytes

Span<Byte>

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

flush

Boolean

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

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

Int32

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

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

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

Encoder.cs

Важно!

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

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

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

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

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

Параметры

chars

Char*

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

charCount

Int32

Число символов для кодирования.

bytes

Byte*

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

byteCount

Int32

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

flush

Boolean

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

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

Int32

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

Атрибуты

CLSCompliantAttribute

Исключения

ArgumentNullException

chars is null (Nothing).

–или–

bytes is null (Nothing).

ArgumentOutOfRangeException

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

ArgumentException

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

EncoderFallbackException

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

-и-

Fallback задан как EncoderExceptionFallback.

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

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

Encoder.cs

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

public:
 abstract int GetBytes(cli::array <char> ^ chars, int charIndex, int charCount, cli::array <System::Byte> ^ bytes, int byteIndex, bool flush);

public abstract int GetBytes(char[] chars, int charIndex, int charCount, byte[] bytes, int byteIndex, bool flush);

abstract member GetBytes : char[] * int * int * byte[] * int * bool -> int

Public MustOverride Function GetBytes (chars As Char(), charIndex As Integer, charCount As Integer, bytes As Byte(), byteIndex As Integer, flush As Boolean) As Integer

Параметры

chars

Char[]

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

charIndex

Int32

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

charCount

Int32

Число символов для кодирования.

bytes

Byte[]

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

byteIndex

Int32

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

flush

Boolean

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

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

Int32

Фактическое число байтов, записанных в bytes.

Исключения

ArgumentNullException

chars is null (Nothing).

–или–

bytes is null (Nothing).

ArgumentOutOfRangeException

charIndex или charCountbyteIndex меньше нуля.

–или–

charIndex и charCount не обозначайте допустимый диапазон в chars.

–или–

byteIndex не является допустимым индексом в bytes.

ArgumentException

bytes не имеет достаточной емкости от byteIndex конца массива для размещения результирующего байта.

EncoderFallbackException

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

-и-

Fallback задан как EncoderExceptionFallback.

Примеры

В следующем примере показано, как кодировать диапазон элементов из массива символов и хранить закодированные байты в диапазоне элементов в массиве байтов. Метод GetByteCount используется для определения размера массива, необходимого GetBytesдля .

using System;
using System.Text;

class EncoderExample {
    public static void Main() {
        Byte[] bytes;
        // Unicode characters.
        Char[] chars = new Char[] {
            '\u0023', // #
            '\u0025', // %
            '\u03a0', // Pi
            '\u03a3'  // Sigma
        };
        
        Encoder uniEncoder = Encoding.Unicode.GetEncoder();
        
        int byteCount = uniEncoder.GetByteCount(chars, 0, chars.Length, true);
        bytes = new Byte[byteCount];
        int bytesEncodedCount = uniEncoder.GetBytes(chars, 0, chars.Length, bytes, 0, true);
        
        Console.WriteLine(
            "{0} bytes used to encode characters.", bytesEncodedCount
        );

        Console.Write("Encoded bytes: ");
        foreach (Byte b in bytes) {
            Console.Write("[{0}]", b);
        }
        Console.WriteLine();
    }
}

/* This code example produces the following output.

8 bytes used to encode characters.
Encoded bytes: [35][0][37][0][160][3][163][3]

*/

Imports System.Text
Imports Microsoft.VisualBasic.Strings

Class EncoderExample
    
    Public Shared Sub Main()
        Dim bytes() As Byte
        ' Unicode characters.
        ' ChrW(35)  = #
        ' ChrW(37)  = %
        ' ChrW(928) = Pi
        ' ChrW(931) = Sigma
        Dim chars() As Char = {ChrW(35), ChrW(37), ChrW(928), ChrW(931)}
        
        Dim uniEncoder As Encoder = Encoding.Unicode.GetEncoder()
        
        Dim byteCount As Integer = _
            uniEncoder.GetByteCount(chars, 0, chars.Length, True)
        bytes = New Byte(byteCount - 1) {}
        Dim bytesEncodedCount As Integer = _
            uniEncoder.GetBytes(chars, 0, chars.Length, bytes, 0, True)
        
        Console.WriteLine( _
            "{0} bytes used to encode characters.", _
            bytesEncodedCount _
        )
        
        Console.Write("Encoded bytes: ")
        Dim b As Byte
        For Each b In  bytes
            Console.Write("[{0}]", b)
        Next b
        Console.WriteLine()
    End Sub
End Class

'This code example produces the following output.
'8 bytes used to encode characters.
'Encoded bytes: [35][0][37][0][160][3][163][3]
'