UnicodeEncoding.GetChars Метод

Определение

Декодирует последовательность байтов в набор символов.Decodes a sequence of bytes into a set of characters.

Перегрузки

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

Декодирует последовательность байтов, начало которой задается указателем байта, в набор символов, которые сохраняются начиная с заданного указателя символа.Decodes a sequence of bytes starting at the specified byte pointer into a set of characters that are stored starting at the specified character pointer.

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

Декодирует последовательность байтов из заданного массива байтов в указанный массив символов.Decodes a sequence of bytes from the specified byte array into the specified character array.

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

Важно!

Этот API несовместим с CLS.

Декодирует последовательность байтов, начало которой задается указателем байта, в набор символов, которые сохраняются начиная с заданного указателя символа.Decodes a sequence of bytes starting at the specified byte pointer into a set of characters that are stored starting at the specified character pointer.

public:
 override int GetChars(System::Byte* bytes, int byteCount, char* chars, int charCount);
[System.CLSCompliant(false)]
[System.Runtime.InteropServices.ComVisible(false)]
[System.Security.SecurityCritical]
public override int GetChars (byte* bytes, int byteCount, char* chars, int charCount);
override this.GetChars : nativeptr<byte> * int * nativeptr<char> * int -> int

Параметры

bytes
Byte*

Указатель на первый декодируемый байт.A pointer to the first byte to decode.

byteCount
Int32

Число байтов для декодирования.The number of bytes to decode.

chars
Char*

Указатель на положение, с которого начинается запись результирующего набора символов.A pointer to the location at which to start writing the resulting set of characters.

charCount
Int32

Наибольшее количество символов для записи.The maximum number of characters to write.

Возвраты

Фактическое число символов, записанных в местоположение, которое задано параметром chars.The actual number of characters written at the location indicated by the chars parameter.

Атрибуты

Исключения

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

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

Значение параметра byteCount или charCount меньше нуля.byteCount or charCount is less than zero.

Обнаружение ошибок включено, и параметр bytes содержит недопустимую последовательность байтов.Error detection is enabled, and bytes contains an invalid sequence of bytes.

-или--or- charCount меньше результирующего числа символов.charCount is less than the resulting number of characters.

Произошла отработка отказа (см. полное объяснение в статье Кодировка символов в .NET Framework)A fallback occurred (see Character Encoding in the .NET Framework for fuller explanation) - и --and- Параметру DecoderFallback задается значение DecoderExceptionFallback.DecoderFallback is set to DecoderExceptionFallback.

Комментарии

Чтобы вычислить точный размер массива GetChars , который требуется для хранения результирующих символов, приложение GetCharCountиспользует.To calculate the exact array size that GetChars requires to store the resulting characters, the application uses GetCharCount. Чтобы вычислить максимальный размер массива, приложение должно использовать GetMaxCharCount.To calculate the maximum array size, the application should use GetMaxCharCount. Метод обычно выделяет меньше памяти, в GetMaxCharCount то время как метод обычно выполняется быстрее. GetCharCountThe GetCharCount method generally allocates less memory, while the GetMaxCharCount method generally executes faster.

При обнаружении ошибок недействительная последовательность приводит к тому, что ArgumentExceptionэтот метод выдает исключение.With error detection, an invalid sequence causes this method to throw a ArgumentException. Без обнаружения ошибок недопустимые последовательности пропускаются, и исключение не создается.Without error detection, invalid sequences are ignored, and no exception is thrown.

Если диапазон байтов для декодирования включает метку порядка байтов (BOM), а массив байтов был возвращен методом типа, не поддерживающим СПЕЦИФИКАЦИю, то символ U + ФФФЕ включается в массив символов, возвращаемый этим методом.If the range of bytes to be decoded includes the byte order mark (BOM) and the byte array was returned by a method of a non-BOM aware type, the character U+FFFE is included in the character array returned by this method. Его можно удалить, вызвав String.TrimStart метод.You can remove it by calling the String.TrimStart method.

Данные для преобразования, например данные, считываемые из потока, могут быть доступны только в последовательных блоках.Data to be converted, such as data read from a stream, might be available only in sequential blocks. В этом случае, или если объем данных настолько велик, что необходимо разделить Decoder на меньшие блоки, приложение должно использовать Encoder объект или, GetEncoder предоставленный GetDecoder методом или, соответственно.In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, the application should use the Decoder or the Encoder object provided by the GetDecoder or the GetEncoder method, respectively.

Безопасность

SecurityCriticalAttribute
Требуется полное доверие для немедленного вызывающего объекта.Requires full trust for the immediate caller. Этот член не может использоваться частично доверенным или прозрачным кодом.This member cannot be used by partially trusted or transparent code.

Дополнительно

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

Декодирует последовательность байтов из заданного массива байтов в указанный массив символов.Decodes a sequence of bytes from the specified byte array into the specified character array.

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

Массив байтов, содержащий последовательность байтов, которую требуется декодировать.The byte array containing the sequence of bytes to decode.

byteIndex
Int32

Индекс первого декодируемого байта.The index of the first byte to decode.

byteCount
Int32

Число байтов для декодирования.The number of bytes to decode.

chars
Char[]

Массив символов, в который будет помещен результирующий набор символов.The character array to contain the resulting set of characters.

charIndex
Int32

Индекс, с которого начинается запись результирующего набора символов.The index at which to start writing the resulting set of characters.

Возвраты

Фактическое число символов, записанных в chars.The actual number of characters written into chars.

Исключения

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

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

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

-или--or- Параметрыbyteindex и byteCount не указывают допустимый диапазон в bytes.byteindex and byteCount do not denote a valid range in bytes.

-или--or- Значение параметра charIndex не является допустимым индексом в chars.charIndex is not a valid index in chars.

Обнаружение ошибок включено, и параметр bytes содержит недопустимую последовательность байтов.Error detection is enabled, and bytes contains an invalid sequence of bytes.

- или --or- Недостаточно емкости chars от charIndex до конца массива для размещения полученных символов.chars does not have enough capacity from charIndex to the end of the array to accommodate the resulting characters.

Произошла отработка отказа (см. полное объяснение в статье Кодировка символов в .NET Framework)A fallback occurred (see Character Encoding in the .NET Framework for fuller explanation) - и --and- Параметру DecoderFallback задается значение DecoderExceptionFallback.DecoderFallback is set to DecoderExceptionFallback.

Примеры

В следующем примере показано, как использовать GetChars метод для декодирования диапазона элементов в массиве байтов и сохранения результата в массиве символов.The following example demonstrates how to use the GetChars method to decode a range of elements in a byte array and store the result in a character array.

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.To calculate the exact array size required by GetChars to store the resulting characters, the application uses GetCharCount. Чтобы вычислить максимальный размер массива, приложение должно использовать GetMaxCharCount.To calculate the maximum array size, the application should use GetMaxCharCount. Метод обычно выделяет меньше памяти, в GetMaxCharCount то время как метод обычно выполняется быстрее. GetCharCountThe GetCharCount method generally allocates less memory, while the GetMaxCharCount method generally executes faster.

При обнаружении ошибок недействительная последовательность приводит к тому, что ArgumentExceptionэтот метод выдает исключение.With error detection, an invalid sequence causes this method to throw a ArgumentException. Без обнаружения ошибок недопустимые последовательности пропускаются, и исключение не создается.Without error detection, invalid sequences are ignored, and no exception is thrown.

Если диапазон байтов для декодирования включает метку порядка байтов (BOM), а массив байтов был возвращен методом типа, не поддерживающим СПЕЦИФИКАЦИю, то символ U + ФФФЕ включается в массив символов, возвращаемый этим методом.If the range of bytes to be decoded includes the byte order mark (BOM) and the byte array was returned by a method of a non-BOM aware type, the character U+FFFE is included in the character array returned by this method. Его можно удалить, вызвав String.TrimStart метод.You can remove it by calling the String.TrimStart method.

Данные для преобразования, например данные, считываемые из потока, могут быть доступны только в последовательных блоках.Data to be converted, such as data read from a stream, might be available only in sequential blocks. В этом случае, или если объем данных настолько велик, что необходимо разделить Decoder на меньшие блоки, приложение должно использовать Encoder или, предоставляемые GetDecoder методом или GetEncoder методом соответственно.In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, the application should use the Decoder or the Encoder provided by the GetDecoder method or the GetEncoder method, respectively.

Дополнительно

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