UTF8Encoding.GetChars メソッド

定義

名前空間:

System.Text

アセンブリ:

System.Text.Encoding.Extensions.dll

バイト シーケンスを文字のセットにデコードします。

オーバーロード

GetChars(ReadOnlySpan<Byte>, Span<Char>)	指定されたバイト スパンを指定された文字スパンにデコードします。
GetChars(Byte*, Int32, Char*, Int32)	指定したバイト ポインターで始まるバイト シーケンスを、指定した文字ポインターを開始位置として格納される文字のセットにデコードします。
GetChars(Byte[], Int32, Int32, Char[], Int32)	指定したバイト配列に格納されているバイト シーケンスを指定した文字配列にデコードします。

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

ソース:

UTF8Encoding.cs

指定されたバイト スパンを指定された文字スパンにデコードします。

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

public override int GetChars (ReadOnlySpan<byte> bytes, Span<char> chars);

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

Public Overrides Function GetChars (bytes As ReadOnlySpan(Of Byte), chars As Span(Of Char)) As Integer

パラメーター

bytes

ReadOnlySpan<Byte>

デコードするバイトを格納しているスパン。

chars

Span<Char>

結果の文字セットを格納するスパン。

戻り値

Int32

chars に書き込まれた実際の文字数。

注釈

結果の文字を格納するために 必要な GetChars 正確なサイズを計算するには、 メソッドを GetCharCount 呼び出します。 最大サイズを計算するには、 メソッドを GetMaxCharCount 呼び出します。 メソッドは通常、割り当てるメモリが少なくなりますが、メソッドの実行速度は GetCharCount 一般に GetMaxCharCount 速くなります。

エラー検出では、無効なシーケンスにより、このメソッドによって例外が ArgumentException スローされます。 エラー検出がないと、無効なシーケンスは無視され、例外はスローされません。

デコードするバイトセットにバイト オーダー マーク (BOM) が含まれていて、バイトのスパンが BOM 対応でない型のメソッドによって返された場合、このメソッドによって返される文字のスパンに文字 U+FFFE が含まれます。 これを削除するには、 メソッドを String.TrimStart 呼び出します。

ストリームから読み取られたデータなど、変換するデータは、シーケンシャル ブロックでのみ使用できます。 この場合、またはデータの量が大きくて小さいブロックに分割する必要がある場合は、 メソッドまたは Encoder メソッドによってGetDecoder提供される オブジェクトまたは GetEncoder オブジェクトをそれぞれ使用Decoderします。

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

ソース:

UTF8Encoding.cs

重要

この API は CLS 準拠ではありません。

指定したバイト ポインターで始まるバイト シーケンスを、指定した文字ポインターを開始位置として格納される文字のセットにデコードします。

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

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

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

パラメーター

bytes

Byte*

デコードする最初のバイトへのポインター。

byteCount

Int32

デコードするバイト数。

chars

Char*

結果の文字セットの書き込みを開始する位置へのポインター。

charCount

Int32

書き込む文字の最大数。

戻り値

Int32

chars によって示される位置に書き込まれる実際の文字数。

属性

CLSCompliantAttribute

例外

ArgumentNullException

bytes は null です。

または

chars は null です。

ArgumentOutOfRangeException

byteCount または charCount が 0 未満です。

ArgumentException

エラーの検出が有効になり、bytes に無効なバイト シーケンスが含まれています。

または

charCount が結果の文字数より少なくなっています。

DecoderFallbackException

フォールバックが発生しました (詳細については「.NET での文字エンコード」を参照)

および

DecoderFallback が DecoderExceptionFallback に設定されます。

注釈

結果の文字を格納するために 必要な GetChars 配列サイズを正確に計算するには、 メソッドを GetCharCount 呼び出します。 配列の最大サイズを計算するには、メソッドを呼び出し GetMaxCharCount ます。 メソッドは通常、割り当てるメモリが少なくなりますが、メソッドの実行速度は GetCharCount 一般に GetMaxCharCount 速くなります。

エラー検出では、無効なシーケンスにより、このメソッドによって例外が ArgumentException スローされます。 エラー検出がないと、無効なシーケンスは無視され、例外はスローされません。

デコードするバイト範囲にバイト オーダー マーク (BOM) が含まれていて、バイト配列が BOM 対応でない型のメソッドによって返された場合、このメソッドによって返される文字配列には、文字 U + FFFE が含まれます。 これを削除するには、 メソッドを String.TrimStart 呼び出します。

ストリームから読み取られたデータなど、変換するデータは、シーケンシャル ブロックでのみ使用できます。 この場合、またはデータの量が大きくて小さいブロックに分割する必要がある場合は、 メソッドまたは Encoder メソッドによってGetDecoder提供される オブジェクトまたは GetEncoder オブジェクトをそれぞれ使用Decoderします。

こちらもご覧ください

• GetCharCount(Byte[], Int32, Int32)
• GetMaxCharCount(Int32)
• GetDecoder()
• GetString(Byte[], Int32, Int32)

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

ソース:

UTF8Encoding.cs

指定したバイト配列に格納されているバイト シーケンスを指定した文字配列にデコードします。

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

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

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

Public Overrides 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です。

または

chars は null です。

ArgumentOutOfRangeException

byteIndex、byteCount、または charIndex が 0 未満です。

または

byteindex および byteCount は bytesにおいて有効な範囲を表していません。

または

charIndex が chars の有効なインデックスではありません。

ArgumentException

エラーの検出が有効になり、bytes に無効なバイト シーケンスが含まれています。

または

chars には、charIndex から配列の末尾までに十分なサイズがなく、結果の文字を格納できません。

DecoderFallbackException

フォールバックが発生しました (詳細については「.NET での文字エンコード」を参照)

および

DecoderFallback が DecoderExceptionFallback に設定されます。

例

次の例では、 メソッドを GetChars 使用してバイト配列内の要素の範囲をデコードし、結果を文字配列に格納します。

using namespace System;
using namespace System::Text;
using namespace System::Collections;
int main()
{
   array<Char>^chars;
   array<Byte>^bytes = {85,84,70,56,32,69,110,99,111,100,105,110,103,32,69,120,97,109,112,108,101};
   UTF8Encoding^ utf8 = gcnew UTF8Encoding;
   int charCount = utf8->GetCharCount( bytes, 2, 13 );
   chars = gcnew array<Char>(charCount);
   int charsDecodedCount = utf8->GetChars( bytes, 2, 13, 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();
}

using System;
using System.Text;

class UTF8EncodingExample {
    public static void Main() {
        Char[] chars;
        Byte[] bytes = new Byte[] {
             85,  84,  70,  56,  32,  69, 110,
             99, 111, 100, 105, 110, 103,  32,
             69, 120,  97, 109, 112, 108, 101
        };

        UTF8Encoding utf8 = new UTF8Encoding();

        int charCount = utf8.GetCharCount(bytes, 2, 13);
        chars = new Char[charCount];
        int charsDecodedCount = utf8.GetChars(bytes, 2, 13, 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();
    }
}

Imports System.Text

Class UTF8EncodingExample
    
    Public Shared Sub Main()
        Dim chars() As Char
        Dim bytes() As Byte = { _
            85,  84,  70,  56,  32,  69, 110, _
            99, 111, 100, 105, 110, 103,  32, _
            69, 120,  97, 109, 112, 108, 101 _
        }
        
        Dim utf8 As New UTF8Encoding()
        
        Dim charCount As Integer = utf8.GetCharCount(bytes, 2, 13)
        chars = New Char(charCount - 1) {}
        Dim charsDecodedCount As Integer = utf8.GetChars(bytes, 2, 13, 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

注釈

結果の文字を格納するために 必要な GetChars 配列サイズを正確に計算するには、 メソッドを GetCharCount 呼び出します。 配列の最大サイズを計算するには、メソッドを呼び出し GetMaxCharCount ます。 メソッドは通常、割り当てるメモリが少なくなりますが、メソッドの実行速度は GetCharCount 一般に GetMaxCharCount 速くなります。

エラー検出では、無効なシーケンスにより、このメソッドによって例外が ArgumentException スローされます。 エラー検出がないと、無効なシーケンスは無視され、例外はスローされません。

デコードするバイト範囲にバイト オーダー マーク (BOM) が含まれていて、バイト配列が BOM 対応でない型のメソッドによって返された場合、このメソッドによって返される文字配列には、文字 U + FFFE が含まれます。 これを削除するには、 メソッドを String.TrimStart 呼び出します。

ストリームから読み取られたデータなど、変換するデータは、シーケンシャル ブロックでのみ使用できます。 この場合、またはデータの量が大きくて小さいブロックに分割する必要がある場合は、 メソッドまたは メソッドによってGetDecoder提供される または GetEncoderEncoder をそれぞれ使用Decoderします。

こちらもご覧ください

• GetCharCount(Byte[], Int32, Int32)
• GetMaxCharCount(Int32)
• GetDecoder()
• GetString(Byte[], Int32, Int32)