Encoder.GetBytes Метод

  • Ссылка

Определение

Пространство имен:
System.Text
Сборка:
System.Runtime.dll
Сборка:
netstandard.dll
Сборка:
mscorlib.dll
Сборка:
System.Text.Encoding.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
Исходный код:
Encoder.cs
Исходный код:
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
Исходный код:
Encoder.cs
Исходный код:
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)]
[System.Runtime.InteropServices.ComVisible(false)]
public virtual int GetBytes (char* chars, int charCount, byte* bytes, int byteCount, bool flush);
[System.CLSCompliant(false)]
[System.Runtime.InteropServices.ComVisible(false)]
[System.Security.SecurityCritical]
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
[<System.CLSCompliant(false)>]
[<System.Runtime.InteropServices.ComVisible(false)>]
abstract member GetBytes : nativeptr<char> * int * nativeptr<byte> * int * bool -> int
override this.GetBytes : nativeptr<char> * int * nativeptr<byte> * int * bool -> int
[<System.CLSCompliant(false)>]
[<System.Runtime.InteropServices.ComVisible(false)>]
[<System.Security.SecurityCritical>]
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 ComVisibleAttribute SecurityCriticalAttribute

Исключения

ArgumentNullException

chars имеет значение null (Nothing).

-или-

bytes имеет значение null (Nothing).

ArgumentOutOfRangeException

Значение параметра charCount или byteCount меньше нуля.

ArgumentException

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

EncoderFallbackException

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

- и -

Параметру Fallback задается значение EncoderExceptionFallback.

Применяется к

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

Исходный код:
Encoder.cs
Исходный код:
Encoder.cs
Исходный код:
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 имеет значение null (Nothing).

-или-

bytes имеет значение null (Nothing).

ArgumentOutOfRangeException

Значение параметра charIndex, charCount или byteIndex меньше нуля.

-или-

ПараметрыcharIndex и charCount не указывают допустимый диапазон в chars.

-или-

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

ArgumentException

Недостаточно емкости bytes от byteIndex до конца массива для размещения полученных байтов.

EncoderFallbackException

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

- и -

Параметру Fallback задается значение EncoderExceptionFallback.

Примеры

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

using namespace System;
using namespace System::Text;
using namespace System::Collections;
int main()
{
   array<Byte>^bytes;
   
   // Unicode characters.
   
   // Pi
   // Sigma
   array<Char>^chars = {L'\u03a0',L'\u03a3',L'\u03a6',L'\u03a9'};
   Encoder^ uniEncoder = Encoding::Unicode->GetEncoder();
   int byteCount = uniEncoder->GetByteCount( chars, 0, chars->Length, true );
   bytes = gcnew array<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: " );
   IEnumerator^ myEnum = bytes->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      Byte b = safe_cast<Byte>(myEnum->Current);
      Console::Write( "[{0}]", b );
   }

   Console::WriteLine();
}

/* This code example produces the following output.

8 bytes used to encode characters.
Encoded bytes: [160][3][163][3][166][3][169][3]

*/

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]
'

Применяется к