// Copyright (C) 1995 Taligent, Inc. All rights reserved.
#if 0
---------------------------------------------------------------------------
> Class:
 | TMIMEDataStream  
> Taxonomy Category:
 | Documented Samples  
 | WebRunner Sample  
> Interface Category:
 | Sample.  
> Inherits From:
 | TForeignData 
> Inherited By:
 | None. 
> Purpose:
 | This class is used to encapsulate a CommonPoint data stream into a form that can be used by the Data Translation framework. It does this by deriving from TForeignData and providing an interface to extract type information in the form of a TMIMEForeignDataType.  
> Instantiation:
 | Allocate on the heap or the stack.  
> Deriving Classes:
 | Deriving classes need to make sure that they continue to follow the protocol expected by TForeignData.  
> Concurrency:
 | _Not_ multithread safe.  
> Resource Use:
 | No special requirements.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TMIMEDataStream::TMIMEDataStream ;
 | 1. TMIMEDataStream (TChunkyStream * adoptStream, const TMIMEForeignDataType & type)  
 | 2. TMIMEDataStream ()  
 | 3. TMIMEDataStream (const TMIMEDataStream & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | 1. Bundles up a CommonPoint stream (TChunkyStream) and a foreign data type to construct a TMIMEDataStream.  
 | 2. Default constructor.  
 | 3. Copy constructor.  
> Calling Context:
 | 1. Called by clients that want to use MIME data in the data translation framework.  
 | 2. Called by the stream-in operators.  
 | 3. Called to copy an object.  
> Parameters:
 = 1. TChunkyStream * adoptStream -The source of the data.  
 = 1. const TMIMEForeignDataType & type -The MIME type for the incoming data stream.  
 = 2. Takes no parameters.  
 = 3. const TMIMEDataStream & source -The object to copy.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TMIMEDataStream::~ TMIMEDataStream ;
 | virtual ~ TMIMEDataStream ()  
> Interface Category:
 | Sample.  
> Purpose:
 | Destructor.  
> Calling Context:
 | Called to destroy an object.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TMIMEDataStream::operator >>=;
 | virtual TStream & operator >>=(TStream & toStream) const  
> Interface Category:
 | Sample.  
> Purpose:
 | Stream-out operator.  
> Calling Context:
 | Called to stream out data.  
> Parameters:
 = TStream & toStream -The stream the object streams itself out to.  
> Return Value:
 | Returns a reference to the stream the object streams itself out to.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TMIMEDataStream::operator <<= ;
 | virtual TStream & operator <<= (TStream & fromStream)  
> Interface Category:
 | Sample.  
> Purpose:
 | Stream-in operator.  
> Calling Context:
 | Called to stream in data.  
> Parameters:
 = TStream & fromStream -The stream the object streams itself in from.  
> Return Value:
 | Returns a reference to the stream the object streams itself in from.  
> Exceptions:
 | Throws TInvalidVersionError if the object version isn't known.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TMIMEDataStream::GetDataType ;
 | virtual const TForeignDataType * GetDataType () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Retrieves the MIME data type for this foreign data object.  
> Calling Context:
 | Called by the Data Translation framework to determine converter suitability.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | Returns a pointer to the TMIMEForeignDataType used in the construction of this object.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TMIMEDataStream::CreateStreamForReading ;
 | virtual TRandomAccessStream * CreateStreamForReading (TMemoryHeap * heap =0) const  
> Interface Category:
 | Sample.  
> Purpose:
 | Creates a readable stream that contains the data from this foreign data type.  
> Calling Context:
 | Called by the Data Translation framework to retrieve data from this data object.  
> Parameters:
 = TMemoryHeap * heap =0 -The heap to create the stream object in.  
> Return Value:
 | Returns the created stream.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TMIMEDataStream::CreateStreamForWriting ;
 | virtual TRandomAccessStream * CreateStreamForWriting (unsigned long initialSize =0, TMemoryHeap * heap =0)  
> Interface Category:
 | Sample.  
> Purpose:
 | Creates a writable stream that can be used in data translation exports.  
> Calling Context:
 | Called by the Data Translation framework to create an export stream.  
> Parameters:
 = unsigned long initialSize =0 -A suggested initial stream size.  
 = TMemoryHeap * heap =0 -The memory heap to create the stream in.  
> Return Value:
 | Returns the new stream.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TMIMEDataStream::CreateDefaultTranscoder ;
 | virtual TTranscoder * CreateDefaultTranscoder (TMemoryHeap * heap =0) const  
> Interface Category:
 | Sample.  
> Purpose:
 | Creates a transcoder to use for incoming text.  
> Calling Context:
 | Called by the Data Translation framework.  
> Parameters:
 = TMemoryHeap * heap =0 -The heap to create the transcoder in.  
> Return Value:
 | Returns the created transcoder.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TMIMEDataStream::operator =;
 | TMIMEDataStream & operator =(const TMIMEDataStream & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | Assignment operator.  
> Calling Context:
 | Called when an object is assigned to another compatible object.  
> Parameters:
 = const TMIMEDataStream & source -The object to assign.  
> Return Value:
 | A non-const reference to the left-hand side object.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif