UnicodeEncoding Clase

Definición

Espacio de nombres:

System.Text

Ensamblados:

netstandard.dll, System.Text.Encoding.Extensions.dll

Source:

UnicodeEncoding.cs

Representa una codificación UTF-16 de caracteres Unicode.

public ref class UnicodeEncoding : System::Text::Encoding

public class UnicodeEncoding : System.Text.Encoding

type UnicodeEncoding = class
    inherit Encoding

Public Class UnicodeEncoding
Inherits Encoding

Herencia

Object

Encoding

UnicodeEncoding

Ejemplos

En el ejemplo siguiente se muestra cómo codificar una cadena de caracteres Unicode en una matriz de bytes mediante un UnicodeEncoding objeto . La matriz de bytes se descodifica en una cadena para demostrar que no se pierden datos.

using System;
using System.Text;

class UnicodeEncodingExample {
    public static void Main() {
        // The encoding.
        UnicodeEncoding unicode = new UnicodeEncoding();
        
        // Create a string that contains Unicode characters.
        String unicodeString =
            "This Unicode string contains two characters " +
            "with codes outside the traditional ASCII code range, " +
            "Pi (\u03a0) and Sigma (\u03a3).";
        Console.WriteLine("Original string:");
        Console.WriteLine(unicodeString);

        // Encode the string.
        Byte[] encodedBytes = unicode.GetBytes(unicodeString);
        Console.WriteLine();
        Console.WriteLine("Encoded bytes:");
        foreach (Byte b in encodedBytes) {
            Console.Write("[{0}]", b);
        }
        Console.WriteLine();
        
        // Decode bytes back to string.
        // Notice Pi and Sigma characters are still present.
        String decodedString = unicode.GetString(encodedBytes);
        Console.WriteLine();
        Console.WriteLine("Decoded bytes:");
        Console.WriteLine(decodedString);
    }
}

Imports System.Text
Imports Microsoft.VisualBasic.Strings

Class UnicodeEncodingExample
    
    Public Shared Sub Main()
        ' The encoding.
        Dim uni As New UnicodeEncoding()
        
        ' Create a string that contains Unicode characters.
        Dim unicodeString As String = _
            "This Unicode string contains two characters " & _
            "with codes outside the traditional ASCII code range, " & _
            "Pi (" & ChrW(928) & ") and Sigma (" & ChrW(931) & ")."
        Console.WriteLine("Original string:")
        Console.WriteLine(unicodeString)
        
        ' Encode the string.
        Dim encodedBytes As Byte() = uni.GetBytes(unicodeString)
        Console.WriteLine()
        Console.WriteLine("Encoded bytes:")
        Dim b As Byte
        For Each b In  encodedBytes
            Console.Write("[{0}]", b)
        Next b
        Console.WriteLine()
        
        ' Decode bytes back to string.
        ' Notice Pi and Sigma characters are still present.
        Dim decodedString As String = uni.GetString(encodedBytes)
        Console.WriteLine()
        Console.WriteLine("Decoded bytes:")
        Console.WriteLine(decodedString)
    End Sub
End Class

En el ejemplo siguiente se usa la misma cadena que la anterior, salvo que escribe los bytes codificados en un archivo y prefijos la secuencia de bytes con una marca de orden de bytes (BOM). A continuación, lee el archivo de dos maneras diferentes: como un archivo de texto mediante un StreamReader objeto y como un archivo binario. Como cabría esperar, ninguna cadena recién leída incluye la lista de materiales.

using System;
using System.IO;
using System.Text;

public class Example
{
   public static void Main()
   {
        // Create a UTF-16 encoding that supports a BOM.
        Encoding unicode = new UnicodeEncoding();

        // A Unicode string with two characters outside an 8-bit code range.
        String unicodeString =
            "This Unicode string has 2 characters outside the " +
            "ASCII range: \n" +
            "Pi (\u03A0)), and Sigma (\u03A3).";
        Console.WriteLine("Original string:");
        Console.WriteLine(unicodeString);
        Console.WriteLine();

        // Encode the string.
        Byte[] encodedBytes = unicode.GetBytes(unicodeString);
        Console.WriteLine("The encoded string has {0} bytes.\n",
                          encodedBytes.Length);

        // Write the bytes to a file with a BOM.
        var fs = new FileStream(@".\UTF8Encoding.txt", FileMode.Create);
        Byte[] bom = unicode.GetPreamble();
        fs.Write(bom, 0, bom.Length);
        fs.Write(encodedBytes, 0, encodedBytes.Length);
        Console.WriteLine("Wrote {0} bytes to the file.\n", fs.Length);
        fs.Close();

        // Open the file using StreamReader.
        var sr = new StreamReader(@".\UTF8Encoding.txt");
        String newString = sr.ReadToEnd();
        sr.Close();
        Console.WriteLine("String read using StreamReader:");
        Console.WriteLine(newString);
        Console.WriteLine();

        // Open the file as a binary file and decode the bytes back to a string.
        fs = new FileStream(@".\UTF8Encoding.txt", FileMode.Open);
        Byte[] bytes = new Byte[fs.Length];
        fs.Read(bytes, 0, (int)fs.Length);
        fs.Close();

        String decodedString = unicode.GetString(bytes);
        Console.WriteLine("Decoded bytes:");
        Console.WriteLine(decodedString);
   }
}
// The example displays the following output:
//    Original string:
//    This Unicode string has 2 characters outside the ASCII range:
//    Pi (π), and Sigma (Σ).
//
//    The encoded string has 172 bytes.
//
//    Wrote 174 bytes to the file.
//
//    String read using StreamReader:
//    This Unicode string has 2 characters outside the ASCII range:
//    Pi (π), and Sigma (Σ).
//
//    Decoded bytes:
//    This Unicode string has 2 characters outside the ASCII range:
//    Pi (π), and Sigma (Σ).

Imports System.IO
Imports System.Text

Class Example
    Public Shared Sub Main()
        ' Create a UTF-16 encoding that supports a BOM.
        Dim unicode As New UnicodeEncoding()
        
        ' A Unicode string with two characters outside an 8-bit code range.
        Dim unicodeString As String = _
            "This Unicode string has 2 characters outside the " &
            "ASCII range: " & vbCrLf &
            "Pi (" & ChrW(&h03A0) & "), and Sigma (" & ChrW(&h03A3) & ")."
        Console.WriteLine("Original string:")
        Console.WriteLine(unicodeString)
        Console.WriteLine()
        
        ' Encode the string.
        Dim encodedBytes As Byte() = unicode.GetBytes(unicodeString)
        Console.WriteLine("The encoded string has {0} bytes.",
                          encodedBytes.Length)
        Console.WriteLine()
        
        ' Write the bytes to a file with a BOM.
        Dim fs As New FileStream(".\UnicodeEncoding.txt", FileMode.Create)
        Dim bom() As Byte = unicode.GetPreamble()
        fs.Write(bom, 0, bom.Length)
        fs.Write(encodedBytes, 0, encodedBytes.Length)
        Console.WriteLine("Wrote {0} bytes to the file.", fs.Length)
        fs.Close()
        Console.WriteLine()
        
        ' Open the file using StreamReader.
        Dim sr As New StreamReader(".\UnicodeEncoding.txt")
        Dim newString As String = sr.ReadToEnd()
        sr.Close()
        Console.WriteLine("String read using StreamReader:")
        Console.WriteLine(newString)
        Console.WriteLine()
        
        ' Open the file as a binary file and decode the bytes back to a string.
        fs = new FileStream(".\UnicodeEncoding.txt", FileMode.Open)
        Dim bytes(fs.Length - 1) As Byte
        fs.Read(bytes, 0, fs.Length)
        fs.Close()

        Dim decodedString As String = unicode.GetString(bytes)
        Console.WriteLine("Decoded bytes:")
        Console.WriteLine(decodedString)
    End Sub
End Class
' The example displays the following output:
'    Original string:
'    This Unicode string has 2 characters outside the ASCII range:
'    Pi (π), and Sigma (Σ).
'
'    The encoded string has 172 bytes.
'
'    Wrote 174 bytes to the file.
'
'    String read using StreamReader:
'    This Unicode string has 2 characters outside the ASCII range:
'    Pi (π), and Sigma (Σ).
'
'    Decoded bytes:
'    This Unicode string has 2 characters outside the ASCII range:
'    Pi (π), and Sigma (Σ).

Comentarios

La codificación es el proceso de transformar un conjunto de caracteres Unicode en una secuencia de bytes. La descodificación es el proceso de transformar una secuencia de bytes codificados en un conjunto de caracteres Unicode.

El estándar Unicode asigna un punto de código (un número) a cada carácter de cada script admitido. Un formato de transformación Unicode (UTF) es una manera de codificar ese punto de código. El estándar Unicode usa las siguientes UDF:

• UTF-8, que representa cada punto de código como una secuencia de uno a cuatro bytes.

• UTF-16, que representa cada punto de código como una secuencia de uno a dos enteros de 16 bits.

• UTF-32, que representa cada punto de código como un entero de 32 bits.

Para obtener más información sobre las UDF y otras codificaciones admitidas por System.Text, vea Codificación de caracteres en .NET Framework.

La UnicodeEncoding clase representa una codificación UTF-16. El codificador puede usar el orden de bytes big endian (primero el byte más significativo) o el orden de bytes poco endian (byte menos significativo primero). Por ejemplo, la letra mayúscula latina A (punto de código U+0041) se serializa de la siguiente manera (en hexadecimal):

• Orden de bytes big endian: 00 00 00 00 41

• Pequeño orden de bytes endian: 41 00 00 00

Por lo general, es más eficaz almacenar caracteres Unicode mediante el orden de bytes nativo de una plataforma determinada. Por ejemplo, es mejor usar el orden de bytes little-endian en plataformas little-endian, como equipos Intel. La UnicodeEncoding clase corresponde a las páginas de códigos de Windows 1200 (pequeño orden de bytes endian) y 1201 (orden de bytes big endian). Puede determinar la "endianness" de una arquitectura determinada llamando al BitConverter.IsLittleEndian método .

Opcionalmente, el UnicodeEncoding objeto proporciona una marca de orden de bytes (BOM), que es una matriz de bytes que se puede prefijar a la secuencia de bytes resultante del proceso de codificación. Si el preámbulo contiene una marca de orden de bytes (BOM), ayuda al descodificador a determinar el orden de bytes y el formato de transformación o UTF.

Si la UnicodeEncoding instancia está configurada para proporcionar una lista de materiales, puede recuperarla llamando al GetPreamble método ; de lo contrario, el método devuelve una matriz vacía. Tenga en cuenta que, incluso si un UnicodeEncoding objeto está configurado para la compatibilidad con BOM, debe incluir la BOM al principio de la secuencia de bytes codificada según corresponda; los métodos de codificación de la UnicodeEncoding clase no lo hacen automáticamente.

Precaución

Para habilitar la detección de errores y para que la instancia de clase sea más segura, debe crear instancias de un UnicodeEncoding objeto llamando al UnicodeEncoding(Boolean, Boolean, Boolean) constructor y estableciendo su throwOnInvalidBytes argumento trueen . Con la detección de errores, un método que detecta una secuencia de caracteres o bytes no válida produce una ArgumentExceptionexcepción . Sin detección de errores, no se produce ninguna excepción y, por lo general, se omite la secuencia no válida.

Puede crear instancias de un UnicodeEncoding objeto de varias maneras, dependiendo de si desea proporcionar una marca de orden de bytes (BOM), tanto si desea codificar big-endian como little-endian, y si desea habilitar la detección de errores. En la tabla siguiente se enumeran los UnicodeEncoding constructores y las Encoding propiedades que devuelven un UnicodeEncoding objeto .

Miembro	Endianidad	BOM	Detección de errores
BigEndianUnicode	Big-endian	Sí	No (reserva de reemplazo)
Encoding.Unicode	Formato Little-endian	Sí	No (reserva de reemplazo)
UnicodeEncoding.UnicodeEncoding()	Formato Little-endian	Sí	No (reserva de reemplazo)
UnicodeEncoding(Boolean, Boolean)	Configurable	Configurable	No (reserva de reemplazo)
UnicodeEncoding.UnicodeEncoding(Boolean, Boolean, Boolean)	Configurable	Configurable	Configurable

El GetByteCount método determina cuántos bytes dan como resultado la codificación de un conjunto de caracteres Unicode y el GetBytes método realiza la codificación real.

Del mismo modo, el GetCharCount método determina cuántos caracteres producen la descodificación de una secuencia de bytes y los GetChars métodos y GetString realizan la descodificación real.

Para un codificador o descodificador que pueda guardar información de estado al codificar o descodificar datos que abarquen varios bloques (como la cadena de 1 millón de caracteres codificados en segmentos de 100 000 caracteres), use las GetEncoder propiedades y GetDecoder , respectivamente.

Constructores

Nombre	Description
UnicodeEncoding()	Inicializa una nueva instancia de la clase UnicodeEncoding.
UnicodeEncoding(Boolean, Boolean, Boolean)	Inicializa una nueva instancia de la clase UnicodeEncoding. Los parámetros especifican si se debe usar el orden de bytes big endian, si se debe proporcionar una marca de orden de bytes Unicode y si se produce una excepción cuando se detecta una codificación no válida.
UnicodeEncoding(Boolean, Boolean)	Inicializa una nueva instancia de la clase UnicodeEncoding. Los parámetros especifican si se debe usar el orden de bytes big endian y si el GetPreamble() método devuelve una marca de orden de bytes Unicode.

Campos

Nombre	Description
CharSize	Representa el tamaño de caracteres Unicode en bytes. Este campo es una constante.

Propiedades

Nombre	Description
BodyName	Cuando se reemplaza en una clase derivada, obtiene un nombre para la codificación actual que se puede usar con etiquetas de cuerpo del agente de correo. (Heredado de Encoding)
CodePage	Cuando se reemplaza en una clase derivada, obtiene el identificador de página de códigos del objeto actual Encoding. (Heredado de Encoding)
DecoderFallback	Obtiene o establece el DecoderFallback objeto para el objeto actual Encoding . (Heredado de Encoding)
EncoderFallback	Obtiene o establece el EncoderFallback objeto para el objeto actual Encoding . (Heredado de Encoding)
EncodingName	Cuando se reemplaza en una clase derivada, obtiene la descripción legible de la codificación actual. (Heredado de Encoding)
HeaderName	Cuando se reemplaza en una clase derivada, obtiene un nombre para la codificación actual que se puede usar con etiquetas de encabezado del agente de correo. (Heredado de Encoding)
IsBrowserDisplay	Cuando se reemplaza en una clase derivada, obtiene un valor que indica si los clientes del explorador pueden usar la codificación actual para mostrar contenido. (Heredado de Encoding)
IsBrowserSave	Cuando se reemplaza en una clase derivada, obtiene un valor que indica si los clientes del explorador pueden usar la codificación actual para guardar contenido. (Heredado de Encoding)
IsMailNewsDisplay	Cuando se reemplaza en una clase derivada, obtiene un valor que indica si la codificación actual se puede usar por correo y clientes de noticias para mostrar contenido. (Heredado de Encoding)
IsMailNewsSave	Cuando se reemplaza en una clase derivada, obtiene un valor que indica si la codificación actual se puede usar por correo y clientes de noticias para guardar contenido. (Heredado de Encoding)
IsReadOnly	Cuando se reemplaza en una clase derivada, obtiene un valor que indica si la codificación actual es de solo lectura. (Heredado de Encoding)
IsSingleByte	Cuando se reemplaza en una clase derivada, obtiene un valor que indica si la codificación actual usa puntos de código de un solo byte. (Heredado de Encoding)
Preamble	Obtiene una marca de orden de bytes Unicode codificada en formato UTF-16, si este objeto está configurado para proporcionar uno.
WebName	Cuando se reemplaza en una clase derivada, obtiene el nombre registrado con la Entidad de números asignados a Internet (IANA) para la codificación actual. (Heredado de Encoding)
WindowsCodePage	Cuando se reemplaza en una clase derivada, obtiene la página de códigos del sistema operativo Windows que se corresponde más estrechamente con la codificación actual. (Heredado de Encoding)

Métodos

Nombre	Description
Clone()	Cuando se reemplaza en una clase derivada, crea una copia superficial del objeto actual Encoding . (Heredado de Encoding)
Equals(Object)	Determina si el objeto especificado Object es igual al objeto actual UnicodeEncoding .
GetByteCount(Char[], Int32, Int32)	Calcula el número de bytes generados mediante la codificación de un conjunto de caracteres de la matriz de caracteres especificada.
GetByteCount(Char[])	Cuando se invalida en una clase derivada, calcula el número de bytes generados mediante la codificación de todos los caracteres de la matriz de caracteres especificada. (Heredado de Encoding)
GetByteCount(Char*, Int32)	Calcula el número de bytes generados mediante la codificación de un conjunto de caracteres a partir del puntero de caracteres especificado.
GetByteCount(ReadOnlySpan<Char>)	Cuando se reemplaza en una clase derivada, calcula el número de bytes generados mediante la codificación de los caracteres en el intervalo de caracteres especificado. (Heredado de Encoding)
GetByteCount(String, Int32, Int32)	Cuando se reemplaza en una clase derivada, calcula el número de bytes generados mediante la codificación de un conjunto de caracteres de la cadena especificada. (Heredado de Encoding)
GetByteCount(String)	Calcula el número de bytes generados mediante la codificación de los caracteres de la cadena especificada.
GetBytes(Char[], Int32, Int32, Byte[], Int32)	Codifica un conjunto de caracteres de la matriz de caracteres especificada en la matriz de bytes especificada.
GetBytes(Char[], Int32, Int32)	Cuando se reemplaza en una clase derivada, codifica un conjunto de caracteres de la matriz de caracteres especificada en una secuencia de bytes. (Heredado de Encoding)
GetBytes(Char[])	Cuando se reemplaza en una clase derivada, codifica todos los caracteres de la matriz de caracteres especificada en una secuencia de bytes. (Heredado de Encoding)
GetBytes(Char*, Int32, Byte*, Int32)	Codifica un conjunto de caracteres a partir del puntero de caracteres especificado en una secuencia de bytes que se almacenan a partir del puntero de bytes especificado.
GetBytes(ReadOnlySpan<Char>, Span<Byte>)	Cuando se reemplaza en una clase derivada, codifica en un intervalo de bytes un conjunto de caracteres del intervalo de solo lectura especificado. (Heredado de Encoding)
GetBytes(String, Int32, Int32, Byte[], Int32)	Codifica un conjunto de caracteres del especificado String en la matriz de bytes especificada.
GetBytes(String, Int32, Int32)	Cuando se reemplaza en una clase derivada, codifica en una matriz de bytes el número de caracteres especificado por en la cadena especificada, empezando por count el especificado index. (Heredado de Encoding)
GetBytes(String)	Cuando se reemplaza en una clase derivada, codifica todos los caracteres de la cadena especificada en una secuencia de bytes. (Heredado de Encoding)
GetCharCount(Byte[], Int32, Int32)	Calcula el número de caracteres generados al descodificar una secuencia de bytes de la matriz de bytes especificada.
GetCharCount(Byte[])	Cuando se reemplaza en una clase derivada, calcula el número de caracteres generados al descodificar todos los bytes de la matriz de bytes especificada. (Heredado de Encoding)
GetCharCount(Byte*, Int32)	Calcula el número de caracteres generados por la descodificación de una secuencia de bytes a partir del puntero de bytes especificado.
GetCharCount(ReadOnlySpan<Byte>)	Cuando se reemplaza en una clase derivada, calcula el número de caracteres generados al descodificar el intervalo de bytes de solo lectura proporcionado. (Heredado de Encoding)
GetChars(Byte[], Int32, Int32, Char[], Int32)	Descodifica una secuencia de bytes de la matriz de bytes especificada en la matriz de caracteres especificada.
GetChars(Byte[], Int32, Int32)	Cuando se reemplaza en una clase derivada, descodifica una secuencia de bytes de la matriz de bytes especificada en un conjunto de caracteres. (Heredado de Encoding)
GetChars(Byte[])	Cuando se reemplaza en una clase derivada, descodifica todos los bytes de la matriz de bytes especificada en un conjunto de caracteres. (Heredado de Encoding)
GetChars(Byte*, Int32, Char*, Int32)	Descodifica una secuencia de bytes a partir del puntero de bytes especificado en un conjunto de caracteres que se almacenan a partir del puntero de caracteres especificado.
GetChars(ReadOnlySpan<Byte>, Span<Char>)	Cuando se invalida en una clase derivada, descodifica todos los bytes del intervalo de bytes de solo lectura especificado en un intervalo de caracteres. (Heredado de Encoding)
GetDecoder()	Obtiene un descodificador que convierte una secuencia codificada UTF-16 de bytes en una secuencia de caracteres Unicode.
GetEncoder()	Obtiene un codificador que convierte una secuencia de caracteres Unicode en una secuencia codificada UTF-16 de bytes.
GetHashCode()	Devuelve el código hash de la instancia actual.
GetMaxByteCount(Int32)	Calcula el número máximo de bytes producidos al codificar el número especificado de caracteres.
GetMaxCharCount(Int32)	Calcula el número máximo de caracteres producidos al descodificar el número especificado de bytes.
GetPreamble()	Devuelve una marca de orden de bytes Unicode codificada en formato UTF-16, si el constructor de esta instancia solicita una marca de orden de bytes.
GetString(Byte[], Int32, Int32)	Descodifica un intervalo de bytes de una matriz de bytes en una cadena.
GetString(Byte[])	Cuando se invalida en una clase derivada, descodifica todos los bytes de la matriz de bytes especificada en una cadena. (Heredado de Encoding)
GetString(Byte*, Int32)	Cuando se reemplaza en una clase derivada, descodifica un número especificado de bytes a partir de una dirección especificada en una cadena. (Heredado de Encoding)
GetString(ReadOnlySpan<Byte>)	Cuando se reemplaza en una clase derivada, descodifica todos los bytes del intervalo de bytes especificado en una cadena. (Heredado de Encoding)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
IsAlwaysNormalized()	Obtiene un valor que indica si la codificación actual siempre se normaliza mediante el formulario de normalización predeterminado. (Heredado de Encoding)
IsAlwaysNormalized(NormalizationForm)	Cuando se reemplaza en una clase derivada, obtiene un valor que indica si la codificación actual siempre se normaliza mediante el formulario de normalización especificado. (Heredado de Encoding)
MemberwiseClone()	Crea una copia superficial del Objectactual. (Heredado de Object)
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)
TryGetBytes(ReadOnlySpan<Char>, Span<Byte>, Int32)	Codifica en un intervalo de bytes un conjunto de caracteres del intervalo de solo lectura especificado si el destino es lo suficientemente grande. (Heredado de Encoding)
TryGetChars(ReadOnlySpan<Byte>, Span<Char>, Int32)	Descodifica en un intervalo de caracteres un conjunto de bytes del intervalo de solo lectura especificado si el destino es lo suficientemente grande. (Heredado de Encoding)

Métodos de extensión

Nombre	Description
GetBytes(Encoding, ReadOnlySequence<Char>, IBufferWriter<Byte>)	Descodifica el objeto especificado ReadOnlySequence<T> para byteusar el especificado Encoding y escribe el resultado en writer.
GetBytes(Encoding, ReadOnlySequence<Char>, Span<Byte>)	Codifica el objeto especificado ReadOnlySequence<T> para byteusar el especificado Encoding y genera el resultado en bytes.
GetBytes(Encoding, ReadOnlySequence<Char>)	Codifica el objeto especificado ReadOnlySequence<T> en una Byte matriz mediante el especificado Encoding.
GetBytes(Encoding, ReadOnlySpan<Char>, IBufferWriter<Byte>)	Codifica el objeto especificado ReadOnlySpan<T> para byteusar el especificado Encoding y escribe el resultado en writer.
GetChars(Encoding, ReadOnlySequence<Byte>, IBufferWriter<Char>)	Descodifica el objeto especificado ReadOnlySequence<T> para charusar el especificado Encoding y escribe el resultado en writer.
GetChars(Encoding, ReadOnlySequence<Byte>, Span<Char>)	Descodifica el objeto especificado ReadOnlySequence<T> para charusar el especificado Encoding y genera el resultado en chars.
GetChars(Encoding, ReadOnlySpan<Byte>, IBufferWriter<Char>)	Descodifica el objeto especificado ReadOnlySpan<T> para charusar el especificado Encoding y escribe el resultado en writer.
GetString(Encoding, ReadOnlySequence<Byte>)	Descodifica el objeto especificado ReadOnlySequence<T> en mediante String el especificado Encoding.

Consulte también

• Encoding
• Encoder
• Decoder
• UTF32Encoding
• UTF8Encoding
• UTF7Encoding
• ASCIIEncoding
• UnicodeCategory
• CharUnicodeInfo
• Descripción de las codificaciones