UTF8Encoding.GetBytes Método

Definición

Codifica un juego de caracteres en una secuencia de bytes.Encodes a set of characters into a sequence of bytes.

Sobrecargas

GetBytes(String)

Codifica los caracteres de un objeto String especificado en una secuencia de bytes.Encodes the characters in a specified String object into a sequence of bytes.

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

Codifica el intervalo de caracteres especificado en el intervalo de bytes especificado.Encodes the specified character span into the specified byte span.

GetBytes(Char*, Int32, Byte*, Int32)

Codifica un juego de caracteres a partir del puntero de caracteres especificado en una secuencia de bytes que se almacenan a partir del puntero de bytes especificado.Encodes a set of characters starting at the specified character pointer into a sequence of bytes that are stored starting at the specified byte pointer.

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

Codifica un juego de caracteres de la matriz de caracteres determinada en la matriz de bytes especificada.Encodes a set of characters from the specified character array into the specified byte array.

GetBytes(String, Int32, Int32, Byte[], Int32)

Codifica un juego de caracteres del objeto String especificado en la matriz de bytes especificada.Encodes a set of characters from the specified String into the specified byte array.

GetBytes(String)

Codifica los caracteres de un objeto String especificado en una secuencia de bytes.Encodes the characters in a specified String object into a sequence of bytes.

public:
 override cli::array <System::Byte> ^ GetBytes(System::String ^ s);
public override byte[] GetBytes (string s);
override this.GetBytes : string -> byte[]
Public Overrides Function GetBytes (s As String) As Byte()

Parámetros

s
String

La cadena de caracteres que se va a codificar.The character string to encode.

Devoluciones

Byte[]

Matriz de bytes que contiene los caracteres codificados en la cadena especificada por el parámetro s.A byte array that contains the encoded characters in the string specified by the s parameter.

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

Codifica el intervalo de caracteres especificado en el intervalo de bytes especificado.Encodes the specified character span into the specified byte span.

public:
 override int GetBytes(ReadOnlySpan<char> chars, Span<System::Byte> bytes);
public override int GetBytes (ReadOnlySpan<char> chars, Span<byte> bytes);
override this.GetBytes : ReadOnlySpan<char> * Span<byte> -> int
Public Overrides Function GetBytes (chars As ReadOnlySpan(Of Char), bytes As Span(Of Byte)) As Integer

Parámetros

chars
ReadOnlySpan<Char>

Intervalo de caracteres que se codificará.The character span to encode.

bytes
Span<Byte>

Intervalo que contendrá el conjunto de bytes resultante.The span to contain the resulting set of bytes.

Devoluciones

Número real de bytes escritos en bytes.The actual number of bytes written into bytes.

Comentarios

Para calcular el tamaño exacto que necesita GetBytes para almacenar los bytes resultantes, llame al método GetByteCount.To calculate the exact size required by GetBytes to store the resulting bytes, you call the GetByteCount method. Para calcular el tamaño máximo, llame al método GetMaxByteCount.To calculate the maximum size, you call the GetMaxByteCount method. El método GetByteCount generalmente asigna menos memoria, mientras que el método GetMaxByteCount generalmente se ejecuta más rápido.The GetByteCount method generally allocates less memory, while the GetMaxByteCount method generally executes faster.

Con la detección de errores, una secuencia no válida hace que este método produzca una excepción ArgumentException.With error detection, an invalid sequence causes this method to throw an ArgumentException exception. Sin detección de errores, se omiten las secuencias no válidas y no se produce ninguna excepción.Without error detection, invalid sequences are ignored, and no exception is thrown.

Los datos que se van a convertir, como los datos leídos de una secuencia, pueden estar disponibles solo en bloques secuenciales.Data to be converted, such as data read from a stream, might be available only in sequential blocks. En este caso, o si la cantidad de datos es tan grande que debe dividirse en bloques más pequeños, use el Decoder o el Encoder devuelto por el método GetDecoder o el método GetEncoder, respectivamente.In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, use the Decoder or the Encoder returned by the GetDecoder method or the GetEncoder method, respectively.

Para asegurarse de que los bytes codificados se descodifican correctamente cuando se guardan como un archivo o como un flujo, puede prefijar un flujo de bytes codificados con un preámbulo.To ensure that the encoded bytes are decoded properly when they are saved as a file or as a stream, you can prefix a stream of encoded bytes with a preamble. Insertar el preámbulo al principio de una secuencia de bytes (como al principio de una serie de bytes que se va a escribir en un archivo) es responsabilidad del desarrollador.Inserting the preamble at the beginning of a byte stream (such as at the beginning of a series of bytes to be written to a file) is the developer's responsibility. El método GetBytes no antepone un preámbulo al principio de una secuencia de bytes codificados.The GetBytes method does not prepend a preamble to the beginning of a sequence of encoded bytes.

GetBytes(Char*, Int32, Byte*, Int32)

Importante

Esta API no es conforme a CLS.

Codifica un juego de caracteres a partir del puntero de caracteres especificado en una secuencia de bytes que se almacenan a partir del puntero de bytes especificado.Encodes a set of characters starting at the specified character pointer into a sequence of bytes that are stored starting at the specified byte pointer.

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

Parámetros

chars
Char*

Puntero al primer carácter que se va a codificar.A pointer to the first character to encode.

charCount
Int32

Número de caracteres que se van a codificar.The number of characters to encode.

bytes
Byte*

Puntero a la ubicación en la que se iniciará la escritura de la secuencia de bytes resultante.A pointer to the location at which to start writing the resulting sequence of bytes.

byteCount
Int32

Número máximo de bytes que se pueden escribir.The maximum number of bytes to write.

Devoluciones

Número real de bytes escritos en la ubicación indicada por bytes.The actual number of bytes written at the location indicated by bytes.

Atributos

Excepciones

chars es null.chars is null.

o bien-or- bytes es null.bytes is null.

charCount o byteCount es menor que cero.charCount or byteCount is less than zero.

Está habilitada la detección de errores, y chars contiene una secuencia de caracteres no válida.Error detection is enabled, and chars contains an invalid sequence of characters.

O bien-or- El valor de byteCount es menor que el número resultante de bytes.byteCount is less than the resulting number of bytes.

Se ha producido una reserva (para más información, vea Codificación de caracteres en .NET)A fallback occurred (for more information, see Character Encoding in .NET) - y --and- El valor de EncoderFallback está establecido en EncoderExceptionFallback.EncoderFallback is set to EncoderExceptionFallback.

Comentarios

Para calcular el tamaño exacto de la matriz requerido por GetBytes para almacenar los bytes resultantes, se llama al método GetByteCount.To calculate the exact array size required by GetBytes to store the resulting bytes, you call the GetByteCount method. Para calcular el tamaño máximo de la matriz, llame al método GetMaxByteCount.To calculate the maximum array size, you call the GetMaxByteCount method. El método GetByteCount generalmente asigna menos memoria, mientras que el método GetMaxByteCount generalmente se ejecuta más rápido.The GetByteCount method generally allocates less memory, while the GetMaxByteCount method generally executes faster.

Con la detección de errores, una secuencia no válida hace que este método produzca una excepción ArgumentException.With error detection, an invalid sequence causes this method to throw an ArgumentException exception. Sin detección de errores, se omiten las secuencias no válidas y no se produce ninguna excepción.Without error detection, invalid sequences are ignored, and no exception is thrown.

Los datos que se van a convertir, como los datos leídos de una secuencia, pueden estar disponibles solo en bloques secuenciales.Data to be converted, such as data read from a stream, might be available only in sequential blocks. En este caso, o si la cantidad de datos es tan grande que debe dividirse en bloques más pequeños, use el Decoder o el Encoder devuelto por el método GetDecoder o el método GetEncoder, respectivamente.In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, use the Decoder or the Encoder returned by the GetDecoder method or the GetEncoder method, respectively.

Para asegurarse de que los bytes codificados se descodifican correctamente cuando se guardan como un archivo o como un flujo, puede prefijar un flujo de bytes codificados con un preámbulo.To ensure that the encoded bytes are decoded properly when they are saved as a file or as a stream, you can prefix a stream of encoded bytes with a preamble. Insertar el preámbulo al principio de una secuencia de bytes (como al principio de una serie de bytes que se va a escribir en un archivo) es responsabilidad del desarrollador.Inserting the preamble at the beginning of a byte stream (such as at the beginning of a series of bytes to be written to a file) is the developer's responsibility. El método GetBytes no antepone un preámbulo al principio de una secuencia de bytes codificados.The GetBytes method does not prepend a preamble to the beginning of a sequence of encoded bytes.

Seguridad

SecurityCriticalAttribute
Requiere plena confianza para el llamador inmediato.Requires full trust for the immediate caller. Este miembro no puede ser utilizado por código transparente o de confianza parcial.This member cannot be used by partially trusted or transparent code.

Consulte también:

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

Codifica un juego de caracteres de la matriz de caracteres determinada en la matriz de bytes especificada.Encodes a set of characters from the specified character array into the specified byte array.

public:
 override int GetBytes(cli::array <char> ^ chars, int charIndex, int charCount, cli::array <System::Byte> ^ bytes, int byteIndex);
public override int GetBytes (char[] chars, int charIndex, int charCount, byte[] bytes, int byteIndex);
override this.GetBytes : char[] * int * int * byte[] * int -> int
Public Overrides Function GetBytes (chars As Char(), charIndex As Integer, charCount As Integer, bytes As Byte(), byteIndex As Integer) As Integer

Parámetros

chars
Char[]

Matriz de caracteres que contiene el juego de caracteres que se va a codificar.The character array containing the set of characters to encode.

charIndex
Int32

Índice del primer carácter que se va a codificar.The index of the first character to encode.

charCount
Int32

Número de caracteres que se van a codificar.The number of characters to encode.

bytes
Byte[]

Matriz de bytes que contendrá la secuencia de bytes resultante.The byte array to contain the resulting sequence of bytes.

byteIndex
Int32

Índice en el que se inicia la escritura de la secuencia de bytes resultante.The index at which to start writing the resulting sequence of bytes.

Devoluciones

Número real de bytes escritos en bytes.The actual number of bytes written into bytes.

Excepciones

chars es null.chars is null.

o bien-or- bytes es null.bytes is null.

El valor de charIndex, charCount o byteIndex es menor que cero.charIndex or charCount or byteIndex is less than zero.

o bien-or- charIndex y charCount no denotan un intervalo válido en chars.charIndex and charCount do not denote a valid range in chars.

o bien-or- byteIndex no es un índice válido para bytes.byteIndex is not a valid index in bytes.

Está habilitada la detección de errores, y chars contiene una secuencia de caracteres no válida.Error detection is enabled, and chars contains an invalid sequence of characters.

O bien-or- bytes no tiene suficiente capacidad desde byteIndex hasta el final de la matriz para alojar los bytes resultantes.bytes does not have enough capacity from byteIndex to the end of the array to accommodate the resulting bytes.

Se ha producido una reserva (para más información, vea Codificación de caracteres en .NET)A fallback occurred (for more information, see Character Encoding in .NET) - y --and- El valor de EncoderFallback está establecido en EncoderExceptionFallback.EncoderFallback is set to EncoderExceptionFallback.

Ejemplos

En el ejemplo siguiente se usa el método GetBytes para codificar un intervalo de caracteres de una cadena y almacenar los bytes codificados en un intervalo de elementos de una matriz de bytes.The following example uses the GetBytes method to encode a range of characters from a string and stores the encoded bytes in a range of elements in a byte array.

using namespace System;
using namespace System::Text;
using namespace System::Collections;
int main()
{
   array<Byte>^bytes;
   String^ chars = "UTF8 Encoding Example";
   UTF8Encoding^ utf8 = gcnew UTF8Encoding;
   int byteCount = utf8->GetByteCount( chars->ToCharArray(), 0, 13 );
   bytes = gcnew array<Byte>(byteCount);
   int bytesEncodedCount = utf8->GetBytes( chars, 0, 13, bytes, 0 );
   Console::WriteLine( "{0} bytes used to encode string.", 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();
}

using System;
using System.Text;

class UTF8EncodingExample {
    public static void Main() {
        Byte[] bytes;
        String chars = "UTF8 Encoding Example";
        
        UTF8Encoding utf8 = new UTF8Encoding();
        
        int byteCount = utf8.GetByteCount(chars.ToCharArray(), 0, 13);
        bytes = new Byte[byteCount];
        int bytesEncodedCount = utf8.GetBytes(chars, 0, 13, bytes, 0);
        
        Console.WriteLine(
            "{0} bytes used to encode string.", bytesEncodedCount
        );

        Console.Write("Encoded bytes: ");
        foreach (Byte b in bytes) {
            Console.Write("[{0}]", b);
        }
        Console.WriteLine();
    }
}
Imports System.Text

Class UTF8EncodingExample
    
    Public Shared Sub Main()
        Dim bytes() As Byte
        Dim chars As String = "UTF8 Encoding Example"
        
        Dim utf8 As New UTF8Encoding()
        
        Dim byteCount As Integer = utf8.GetByteCount(chars.ToCharArray(), 0, 13)
        bytes = New Byte(byteCount - 1) {}
        Dim bytesEncodedCount As Integer = utf8.GetBytes(chars, 0, 13, bytes, 0)
        
        Console.WriteLine("{0} bytes used to encode string.", 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

Comentarios

Para calcular el tamaño exacto de la matriz requerido por GetBytes para almacenar los bytes resultantes, se llama al método GetByteCount.To calculate the exact array size required by GetBytes to store the resulting bytes, you call the GetByteCount method. Para calcular el tamaño máximo de la matriz, llame al método GetMaxByteCount.To calculate the maximum array size, you call the GetMaxByteCount method. El método GetByteCount generalmente asigna menos memoria, mientras que el método GetMaxByteCount generalmente se ejecuta más rápido.The GetByteCount method generally allocates less memory, while the GetMaxByteCount method generally executes faster.

Con la detección de errores, una secuencia no válida hace que este método produzca una excepción ArgumentException.With error detection, an invalid sequence causes this method to throw an ArgumentException exception. Sin detección de errores, se omiten las secuencias no válidas y no se produce ninguna excepción.Without error detection, invalid sequences are ignored, and no exception is thrown.

Los datos que se van a convertir, como los datos leídos de una secuencia, pueden estar disponibles solo en bloques secuenciales.Data to be converted, such as data read from a stream, might be available only in sequential blocks. En este caso, o si la cantidad de datos es tan grande que debe dividirse en bloques más pequeños, use el Decoder o el Encoder proporcionado por el método GetDecoder o el método GetEncoder, respectivamente.In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, use the Decoder or the Encoder provided by the GetDecoder method or the GetEncoder method, respectively.

Para asegurarse de que los bytes codificados se descodifican correctamente cuando se guardan como un archivo o como un flujo, puede prefijar un flujo de bytes codificados con un preámbulo.To ensure that the encoded bytes are decoded properly when they are saved as a file or as a stream, you can prefix a stream of encoded bytes with a preamble. Insertar el preámbulo al principio de una secuencia de bytes (como al principio de una serie de bytes que se va a escribir en un archivo) es responsabilidad del desarrollador.Inserting the preamble at the beginning of a byte stream (such as at the beginning of a series of bytes to be written to a file) is the developer's responsibility. El método GetBytes no antepone un preámbulo al principio de una secuencia de bytes codificados.The GetBytes method does not prepend a preamble to the beginning of a sequence of encoded bytes.

Consulte también:

GetBytes(String, Int32, Int32, Byte[], Int32)

Codifica un juego de caracteres del objeto String especificado en la matriz de bytes especificada.Encodes a set of characters from the specified String into the specified byte array.

public:
 override int GetBytes(System::String ^ s, int charIndex, int charCount, cli::array <System::Byte> ^ bytes, int byteIndex);
public override int GetBytes (string s, int charIndex, int charCount, byte[] bytes, int byteIndex);
override this.GetBytes : string * int * int * byte[] * int -> int
Public Overrides Function GetBytes (s As String, charIndex As Integer, charCount As Integer, bytes As Byte(), byteIndex As Integer) As Integer

Parámetros

s
String

String que contiene el juego de caracteres que se va a codificar.The String containing the set of characters to encode.

charIndex
Int32

Índice del primer carácter que se va a codificar.The index of the first character to encode.

charCount
Int32

Número de caracteres que se van a codificar.The number of characters to encode.

bytes
Byte[]

Matriz de bytes que contendrá la secuencia de bytes resultante.The byte array to contain the resulting sequence of bytes.

byteIndex
Int32

Índice en el que se inicia la escritura de la secuencia de bytes resultante.The index at which to start writing the resulting sequence of bytes.

Devoluciones

Número real de bytes escritos en bytes.The actual number of bytes written into bytes.

Excepciones

s es null.s is null.

O bien-or- bytes es null.bytes is null.

El valor de charIndex, charCount o byteIndex es menor que cero.charIndex or charCount or byteIndex is less than zero.

O bien-or- charIndex y charCount no denotan un intervalo válido en chars.charIndex and charCount do not denote a valid range in chars.

o bien-or- byteIndex no es un índice válido para bytes.byteIndex is not a valid index in bytes.

Está habilitada la detección de errores, y s contiene una secuencia de caracteres no válida.Error detection is enabled, and s contains an invalid sequence of characters.

o bien-or- bytes no tiene suficiente capacidad desde byteIndex hasta el final de la matriz para alojar los bytes resultantes.bytes does not have enough capacity from byteIndex to the end of the array to accommodate the resulting bytes.

Se ha producido una reserva (para más información, vea Codificación de caracteres en .NET)A fallback occurred (for more information, see Character Encoding in .NET) - y --and- El valor de EncoderFallback está establecido en EncoderExceptionFallback.EncoderFallback is set to EncoderExceptionFallback.

Ejemplos

En el ejemplo siguiente se usa el método GetBytes para codificar un intervalo de elementos de una matriz de caracteres Unicode y almacenar los bytes codificados en un intervalo de elementos de una matriz de bytes.The following example uses the GetBytes method to encode a range of elements from a Unicode character array and store the encoded bytes in a range of elements in a byte array.

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'};
   UTF8Encoding^ utf8 = gcnew UTF8Encoding;
   int byteCount = utf8->GetByteCount( chars, 1, 2 );
   bytes = gcnew array<Byte>(byteCount);
   int bytesEncodedCount = utf8->GetBytes( chars, 1, 2, bytes, 0 );
   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();
}

using System;
using System.Text;

class UTF8EncodingExample {
    public static void Main() {
        Byte[] bytes;
        // Unicode characters.
        Char[] chars = new Char[] {
            '\u0023', // #
            '\u0025', // %
            '\u03a0', // Pi
            '\u03a3'  // Sigma
        };
        
        UTF8Encoding utf8 = new UTF8Encoding();
        
        int byteCount = utf8.GetByteCount(chars, 1, 2);
        bytes = new Byte[byteCount];
        int bytesEncodedCount = utf8.GetBytes(chars, 1, 2, bytes, 0);
        
        Console.WriteLine(
            "{0} bytes used to encode characters.", bytesEncodedCount
        );

        Console.Write("Encoded bytes: ");
        foreach (Byte b in bytes) {
            Console.Write("[{0}]", b);
        }
        Console.WriteLine();
    }
}
Imports System.Text
Imports Microsoft.VisualBasic.Strings

Class UTF8EncodingExample
    
    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 utf8 As New UTF8Encoding()
        
        Dim byteCount As Integer = utf8.GetByteCount(chars, 1, 2)
        bytes = New Byte(byteCount - 1) {}
        Dim bytesEncodedCount As Integer = utf8.GetBytes(chars, 1, 2, bytes, 0)
        
        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

Comentarios

Para calcular el tamaño exacto de la matriz requerido por GetBytes para almacenar los bytes resultantes, se llama al método GetByteCount.To calculate the exact array size required by GetBytes to store the resulting bytes, you call the GetByteCount method. Para calcular el tamaño máximo de la matriz, llame al método GetMaxByteCount.To calculate the maximum array size, you call the GetMaxByteCount method. El método GetByteCount generalmente asigna menos memoria, mientras que el método GetMaxByteCount generalmente se ejecuta más rápido.The GetByteCount method generally allocates less memory, while the GetMaxByteCount method generally executes faster.

Con la detección de errores, una secuencia no válida hace que este método produzca una excepción ArgumentException.With error detection, an invalid sequence causes this method to throw an ArgumentException exception. Sin detección de errores, se omiten las secuencias no válidas y no se produce ninguna excepción.Without error detection, invalid sequences are ignored, and no exception is thrown.

Los datos que se van a convertir, como los datos leídos de una secuencia, pueden estar disponibles solo en bloques secuenciales.Data to be converted, such as data read from a stream, might be available only in sequential blocks. En este caso, o si la cantidad de datos es tan grande que debe dividirse en bloques más pequeños, use el Decoder o el Encoder proporcionado por el método GetDecoder o el método GetEncoder, respectivamente.In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, use the Decoder or the Encoder provided by the GetDecoder method or the GetEncoder method, respectively.

Para asegurarse de que los bytes codificados se descodifican correctamente cuando se guardan como un archivo o como un flujo, puede prefijar un flujo de bytes codificados con un preámbulo.To ensure that the encoded bytes are decoded properly when they are saved as a file or as a stream, you can prefix a stream of encoded bytes with a preamble. Insertar el preámbulo al principio de una secuencia de bytes (como al principio de una serie de bytes que se va a escribir en un archivo) es responsabilidad del desarrollador.Inserting the preamble at the beginning of a byte stream (such as at the beginning of a series of bytes to be written to a file) is the developer's responsibility. El método GetBytes no antepone un preámbulo al principio de una secuencia de bytes codificados.The GetBytes method does not prepend a preamble to the beginning of a sequence of encoded bytes.

Consulte también:

Se aplica a