This documentation is archived and is not being maintained.

ToBase64Transform Class

Converts a CryptoStream to base 64.


Namespace:  System.Security.Cryptography
Assembly:  mscorlib (in mscorlib.dll)

public class ToBase64Transform : ICryptoTransform, 

The ToBase64Transform type exposes the following members.

Public methodToBase64TransformInitializes a new instance of the ToBase64Transform class.

Public propertyCanReuseTransformGets a value indicating whether the current transform can be reused.
Public propertyCanTransformMultipleBlocksGets a value that indicates whether multiple blocks can be transformed.
Public propertyInputBlockSizeGets the input block size.
Public propertyOutputBlockSizeGets the output block size.

Public methodClearReleases all resources used by the ToBase64Transform.
Public methodDispose()Releases all resources used by the current instance of the ToBase64Transform class.
Protected methodDispose(Boolean)Releases the unmanaged resources used by the ToBase64Transform and optionally releases the managed resources.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeReleases the unmanaged resources used by the ToBase64Transform. (Overrides Object.Finalize().)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodTransformBlockConverts the specified region of the input byte array to base 64 and copies the result to the specified region of the output byte array.
Public methodTransformFinalBlockConverts the specified region of the specified byte array to base 64.

Base 64 Content-Transfer-Encoding represents arbitrary bit sequences in a form that is not human readable.

The following code example demonstrates how to use members of the ToBase64Transform class.

using System;
using System.IO;
using System.Security.Cryptography;

class Members
    static void Main(string[] args)
        string appPath = (System.IO.Directory.GetCurrentDirectory() + "\\");

        // Insert your file names into this method call.
        EncodeFromFile(appPath + "members.cs", appPath + "members.enc");

        Console.WriteLine("This sample completed successfully; " +
            "press Enter to exit.");

    // Read in the specified source file and write out an encoded target file.
    private static void EncodeFromFile(string sourceFile, string targetFile) 
        // Verify members.cs exists at the specified directory.
        if (!File.Exists(sourceFile))
            Console.Write("Unable to locate source file located at ");
            Console.WriteLine(sourceFile + ".");
            Console.Write("Please correct the path and run the ");
            Console.WriteLine("sample again.");

        // Retrieve the input and output file streams.
        FileStream inputFileStream = 
            new FileStream(sourceFile, FileMode.Open, FileAccess.Read);
        FileStream outputFileStream = 
            new FileStream(targetFile, FileMode.Create, FileAccess.Write);

        // Create a new ToBase64Transform object to convert to base 64.
        ToBase64Transform base64Transform = new ToBase64Transform();

        // Create a new byte array with the size of the output block size.
        byte[] outputBytes = new byte[base64Transform.OutputBlockSize];

        // Retrieve the file contents into a byte array.
        byte[] inputBytes = new byte[inputFileStream.Length];
        inputFileStream.Read(inputBytes, 0, inputBytes.Length);

        // Verify that multiple blocks can not be transformed.
        if (!base64Transform.CanTransformMultipleBlocks)
            // Initializie the offset size.
            int inputOffset = 0;

            // Iterate through inputBytes transforming by blockSize.
            int inputBlockSize = base64Transform.InputBlockSize;

            while(inputBytes.Length - inputOffset > inputBlockSize)
                    inputBytes.Length - inputOffset,

                inputOffset += base64Transform.InputBlockSize;

            // Transform the final block of data.
            outputBytes = base64Transform.TransformFinalBlock(
                inputBytes.Length - inputOffset);

            outputFileStream.Write(outputBytes, 0, outputBytes.Length);
            Console.WriteLine("Created encoded file at " + targetFile);

        // Determine if the current transform can be reused.
        if (! base64Transform.CanReuseTransform)
            // Free up any used resources.

        // Close file streams.
// This sample produces the following output:
// Created encoded file at C:\ConsoleApplication1\\membersvcs.enc
// This sample completed successfully; press Enter to exit.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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