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 中將 flush 參數設定為 true ，以確保狀態資訊已排清，且編碼的位元組已正確終止。 使用此設定時，編碼器會忽略數據區塊結尾的無效位元組，例如不相符的 Surrogate 或不完整的組合序列，並清除內部緩衝區。

若要計算儲存所產生字元所需的確切緩衝區大小 GetBytes ，應用程式應該使用 GetByteCount。

如果 GetBytes 呼叫 時 flush ， false編碼器會將尾端位元組儲存在內部緩衝區中的數據區塊結尾，並在下一個編碼作業中使用它們。 應用程式應該在呼叫相同區塊之前，立即在數據區塊上呼叫 GetByteCountGetBytes ，以便計算中包含上一個區塊中的任何尾端字元。

如果您的應用程式要轉換輸入資料流的許多區段，請考慮使用 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 為 null (Nothing)。

-或-

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