Base64Encoder.Convert Method (Byte[], Int32, Int32, Byte[], Int32, Int32, Boolean, out Int32, out Int32, out Boolean)

The Convert method applies base64 encoding to data that is provided in a byte array.

Namespace: Microsoft.Exchange.Data.Mime.Encoders
Assembly: Microsoft.Exchange.Data.Common (in microsoft.exchange.data.common.dll)

Syntax

'Declaration
Public Overrides NotOverridable Sub Convert ( _
    input As Byte(), _
    inputIndex As Integer, _
    inputSize As Integer, _
    output As Byte(), _
    outputIndex As Integer, _
    outputSize As Integer, _
    flush As Boolean, _
    <OutAttribute> ByRef inputUsed As Integer, _
    <OutAttribute> ByRef outputUsed As Integer, _
    <OutAttribute> ByRef completed As Boolean _
)

public override sealed void Convert (
    byte[] input,
    int inputIndex,
    int inputSize,
    byte[] output,
    int outputIndex,
    int outputSize,
    bool flush,
    out int inputUsed,
    out int outputUsed,
    out bool completed
)

public:
virtual void Convert (
    array<unsigned char>^ input, 
    int inputIndex, 
    int inputSize, 
    array<unsigned char>^ output, 
    int outputIndex, 
    int outputSize, 
    bool flush, 
    [OutAttribute] int% inputUsed, 
    [OutAttribute] int% outputUsed, 
    [OutAttribute] bool% completed
) override sealed

public final void Convert (
    byte[] input, 
    int inputIndex, 
    int inputSize, 
    byte[] output, 
    int outputIndex, 
    int outputSize, 
    boolean flush, 
    /** @attribute OutAttribute() */ /** @ref */ int inputUsed, 
    /** @attribute OutAttribute() */ /** @ref */ int outputUsed, 
    /** @attribute OutAttribute() */ /** @ref */ boolean completed
)

JScript does not support passing value-type arguments by reference.

Parameters

• input
  A byte array that contains the binary data to encode.

• inputIndex
  The zero-based byte offset in input at which to begin reading the data to convert.

• inputSize
  The maximum number of bytes to be read from input.

• output
  A byte array that will contain the base64-encoded data.

• outputIndex
  The zero-based byte offset in output at which to begin writing the encoded data.

• outputSize
  The number of bytes to use in output.

• flush
  Set flush to true if this is the last block of data to be converted. Otherwise, set flush to false.

• inputUsed
  The number of bytes that are actually read from input.

• outputUsed
  The number of bytes that are actually written to output.

• completed
  A Boolean value that indicates that all data has been successfully encoded. The completed parameter is set to true when either all the input is consumed but the data is not flushed, or the rest of the input was flushed.

Exceptions

Exception type	Condition
ArgumentOutOfRangeException	This exception is thrown if any one of the following is true: Either inputSize or outputSize are less than zero. inputSize is greater than the length of input. outputSize is greater than the length of output. The sum of inputSize and inputIndex is greater than the size of input. The sum of outputSize and outputIndex is greater than the size of output.
ArgumentNullException	This exception is thrown if either input is null (Nothing in Visual Basic) and inputSize is nonzero or output is null (Nothing in Visual Basic).

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2003,

Target Platforms

Windows Server 2003

See Also

Reference

Base64Encoder Class
Base64Encoder Members
Microsoft.Exchange.Data.Mime.Encoders Namespace