Encoder.GetBytes 方法

定义

命名空间:

System.Text

程序集:

System.Runtime.dll

在派生类中重写时，将一组字符编码为一个字节序列。

重载

GetBytes(ReadOnlySpan<Char>, Span<Byte>, Boolean)	在派生类中重写时，将输入字符范围内的一组字符和内部缓冲区中的所有字符编码为存储在输入字节范围中的字节序列。 一个参数指示转换后是否清除编码器的内部状态。
GetBytes(Char*, Int32, Byte*, Int32, Boolean)	在派生类中重写时，将一组字符（从指定的字符指针处开始）和内部缓冲区中的任何字符编码为从指定字节指针开始存储的字节序列。 一个参数指示转换后是否清除编码器的内部状态。
GetBytes(Char[], Int32, Int32, Byte[], Int32, Boolean)	在派生类中重写时，将指定字符数组中的一组字符和内部缓冲区中的任何字符编码到指定的字节数组中。 一个参数指示转换后是否清除编码器的内部状态。

注解

请记住， 对象在 Encoder 调用 GetBytes之间保存状态。 当应用程序使用数据流完成时，它应在上次调用 GetBytes 时将 参数设置为 flushtrue ，以确保刷新状态信息并正确终止编码的字节。 使用此设置时，编码器会忽略数据块末尾的无效字节，例如不匹配的代理项或不完整的组合序列，并清除内部缓冲区。

若要计算存储生成的字符所需的确切缓冲区大小 GetBytes ，应用程序应使用 GetByteCount。

如果 GetBytes 调用 时 flush 设置为 false，则编码器会将尾随字节存储在数据块末尾的内部缓冲区中，并在下一个编码操作中使用它们。 应用程序应在调用同一块之前立即调用GetByteCountGetBytes数据块，以便计算中包括上一个块中的任何尾随字符。

如果应用程序要转换输入流的多个段，请考虑使用 Convert 方法。 GetBytes 如果输出缓冲区不够大，将引发异常，但 Convert 会尽可能多地填充空间，并返回读取的字符和写入的字节。 另请参阅主题以获取 Encoding.GetBytes 更多评论。

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

Source:

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)

Source:

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 为 null (Nothing)。

或

bytes 为 null (Nothing)。

ArgumentOutOfRangeException

charCount 或 byteCount 小于零。

ArgumentException

byteCount 少于所产生的字节数。

EncoderFallbackException

发生回退（有关详细信息，请参阅采用 .NET 的字符编码）

－和－

将 Fallback 设置为 EncoderExceptionFallback。

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

Source:

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