System.Text.Encoder Class

public abstract class Encoder

Base Types

Object
  Encoder

Assembly

mscorlib

Library

BCL

Summary

Converts blocks of characters into blocks of bytes.

Description

[Note: Following instantiation of a Encoder, sequential blocks of characters are converted into blocks of bytes through calls to the System.Text.Encoder.GetBytes(System.Char[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Boolean) method. The encoder maintains state between the conversions, allowing it to correctly encode character sequences that span adjacent blocks. An instance of a specific implementation of the Encoder class is typically obtained through a call to the System.Text.Encoding.GetEncoder .]

Example

The following example demonstrates using the UTF8Encoding implementation of the Encoder class to convert one character array to two byte arrays.

using System;
using System.Text;

public class EncoderExample
{

   public static void Main()
   {

      string str = "Encoder";
      char[] cAry = str.ToCharArray();
      UTF8Encoding utf = new UTF8Encoding();
    
      Encoder e = utf.GetEncoder();
      int count1 = 
         e.GetByteCount(cAry,0,cAry.Length-4,false);
      int count2 = 
         e.GetByteCount(cAry,cAry.Length-4,4,true);
      byte[] bytes1 = new byte[count1];
      byte[] bytes2 = new byte[count2];
      
      e.GetBytes(cAry,0,cAry.Length-4,bytes1,0,false);
      e.GetBytes(cAry,cAry.Length-4,4,bytes2,0,true);

      Console.Write("Bytes1: ");
      foreach (byte b in bytes1)
         Console.Write(" '{0}' ", b);
      Console.WriteLine();

      Console.Write("Bytes2: ");
      foreach (byte b in bytes2)
         Console.Write(" '{0}' ", b);
      Console.WriteLine();
            
   }

}

The output is

Bytes1: '69' '110' '99'

Bytes2: '111' '100' '101' '114'

See Also

System.Text Namespace

Members

Encoder Constructors

Encoder Constructor

Encoder Methods

Encoder.GetByteCount Method
Encoder.GetBytes Method

Constructs a new instance of the Encoder class.

Description

This constructor is called only by classes that inherit from the Encoder class.

See Also

System.Text.Encoder Class, System.Text Namespace

chars

A Char array of characters to encode.

index

A Int32 that specifies the first index of chars to encode.

count

A Int32 that specifies the number of elements in chars to encode.

flush

A Boolean value that determines whether the current instance flushes its internal state following a conversion. Specify true to flush the internal state of the current instance following a conversion; otherwise, specify false .

Return Value

A Int32 containing the number of bytes required to encode the range in chars from index to index + count for a particular encoding.

[Note: This value takes into account the state in which the current instance was left following the last call to System.Text.Encoder.GetBytes(System.Char[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Boolean) .]

Exceptions

Exception Type	Condition
ArgumentNullException	chars is null .
ArgumentOutOfRangeException	Return value is greater than System.Int32.MaxValue. -or- index < 0. -or- count < 0. -or- index and count do not specify a valid range in chars (i.e. (index + count) > chars.Length).

Description

The state of the current instance is not affected by a call to this method.

[Behaviors: As described above.]

[Overrides: Override this method to retrieve the exact number of bytes required to encode a specified range of an array of Char objects for a particular encoding.]

[Usage: Use this method to determine the exact number of bytes required to encode the specified range of an array of Char objects for a particular encoding.]

See Also

System.Text.Encoder Class, System.Text Namespace

chars

A Char array of characters to encode.

charIndex

A Int32 that specifies the first index of chars to encode.

charCount

A Int32 that specifies the number of elements in chars to encode.

bytes

A Byte array to encode into.

byteIndex

A Int32 that specifies the first index of bytes to encode into.

flush

A Boolean value. Specify true to flush the internal state of the current instance following a conversion; otherwise, specify false . [Note: To ensure correct termination of a sequence of blocks of encoded bytes, it is recommended that the last call to System.Text.Encoder.GetBytes(System.Char[],System.Int32,System.Int32,System.Byte[],System.Int32,System.Boolean) specify true .]

Return Value

A Int32 containing the number of bytes encoded into bytes for a particular encoding.

Exceptions

Exception Type	Condition
ArgumentException	bytes does not contain sufficient space to store the encoded characters.
ArgumentNullException	chars is null . -or- bytes is null .
ArgumentOutOfRangeException	charIndex < 0. -or- charCount < 0. -or- byteIndex < 0. -or- (chars.Length - charIndex) < charCount. -or- byteIndex > bytes.Length.

Description

The encoding takes into account the state in which the current instance was left following the last call to this method if flush was specified as true for that call.

[Behaviors: As described above.]

[Overrides: Override this method to encode the values of an array of Char objects as an array of Byte objects for a particular encoding.]

[Usage: Use this method to encode the values of an array of Char objects as an array of Byte objects for a particular encoding.]

See Also

System.Text.Encoder Class, System.Text Namespace