UnicodeEncoding.GetChars Метод

Определение

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

System.Text

Сборка:

System.Text.Encoding.Extensions.dll

Сборка:

mscorlib.dll

Сборка:

netstandard.dll

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

Перегрузки

GetChars(Byte*, Int32, Char*, Int32)	Декодирует последовательность байтов, начало которой задается указателем байта, в набор символов, которые сохраняются начиная с заданного указателя символа.
GetChars(Byte[], Int32, Int32, Char[], Int32)	Декодирует последовательность байтов из заданного массива байтов в указанный массив символов.

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

Важно!

Этот 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)]
[System.Security.SecurityCritical]
public override int GetChars (byte* bytes, int byteCount, char* chars, int charCount);

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

[System.CLSCompliant(false)]
[System.Security.SecurityCritical]
[System.Runtime.InteropServices.ComVisible(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

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

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

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

Параметры

bytes

Byte*

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

byteCount

Int32

Число байтов для декодирования.

chars

Char*

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

charCount

Int32

Наибольшее количество символов для записи.

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

Int32

Фактическое число символов, записанных в местоположение, которое задано параметром chars.

Атрибуты

CLSCompliantAttribute SecurityCriticalAttribute ComVisibleAttribute

Исключения

ArgumentNullException

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

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

ArgumentOutOfRangeException

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

ArgumentException

Обнаружение ошибок включено, и параметр bytes содержит недопустимую последовательность байтов.

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

DecoderFallbackException

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

• и - Параметру DecoderFallback задается значение DecoderExceptionFallback.

Комментарии

Чтобы вычислить точный размер массива, который GetChars требуется сохранить результирующие символы, приложение использует GetCharCount. Чтобы вычислить максимальный размер массива, приложение должно использовать GetMaxCharCount. Метод GetCharCount обычно выделяет меньше памяти, а GetMaxCharCount метод обычно выполняется быстрее.

При обнаружении ошибок недопустимая последовательность приводит к тому, что этот метод вызывает исключение ArgumentException. Без обнаружения ошибок недопустимые последовательности игнорируются и исключение не возникает.

Если диапазон декодированных байтов включает метку порядка байтов (BOM) и массив байтов был возвращен методом типа, не поддерживающего BOM, символ U+FFFE включается в массив символов, возвращаемый этим методом. Его можно удалить, вызвав String.TrimStart метод.

Преобразуемые данные, такие как чтение данных из потока, могут быть доступны только в последовательных блоках. В этом случае или если объем данных настолько велик, что его необходимо разделить на меньшие блоки, приложение должно использовать Decoder объект или Encoder объект, предоставленный методом GetDecoder GetEncoder соответственно.

См. также раздел

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

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

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

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 (Nothing).

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

ArgumentOutOfRangeException

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

-или- Параметры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,0,110,0,105,0,99,0,111,0,100,0,101,0};
   UnicodeEncoding^ Unicode = gcnew UnicodeEncoding;
   int charCount = Unicode->GetCharCount( bytes, 2, 8 );
   chars = gcnew array<Char>(charCount);
   int charsDecodedCount = Unicode->GetChars( bytes, 2, 8, 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 UnicodeEncodingExample {
    public static void Main() {
        Char[] chars;
        Byte[] bytes = new Byte[] {
            85, 0, 110, 0, 105, 0, 99, 0, 111, 0, 100, 0, 101, 0
        };

        UnicodeEncoding Unicode = new UnicodeEncoding();

        int charCount = Unicode.GetCharCount(bytes, 2, 8);
        chars = new Char[charCount];
        int charsDecodedCount = Unicode.GetChars(bytes, 2, 8, 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 UnicodeEncodingExample
    
    Public Shared Sub Main()
        Dim chars() As Char
        Dim bytes() As Byte = {85, 0, 110, 0, 105, 0, 99, 0, 111, 0, 100, 0, 101, 0}
        
        Dim uni As New UnicodeEncoding()
        
        Dim charCount As Integer = uni.GetCharCount(bytes, 2, 8)
        chars = New Char(charCount - 1) {}
        Dim charsDecodedCount As Integer = uni.GetChars(bytes, 2, 8, 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 метод.

Преобразуемые данные, такие как чтение данных из потока, могут быть доступны только в последовательных блоках. В этом случае или если объем данных настолько велик, что его необходимо разделить на меньшие блоки, приложение должно использовать Decoder метод или Encoder GetDecoder GetEncoder метод соответственно.

См. также раздел

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