FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoIoTextWriter Class Reference

#include <TextWriter.h>

Inherits FdoDisposable.

Inheritance diagram for FdoIoTextWriter:

[legend]
List of all members.

Detailed Description

FdoIoTextWriter writes Unicode wide character text to a binary stream. The text is written in UTF8 format.

Definition at line 27 of file TextWriter.h.


Public Member Functions

FDO_API_COMMON FdoIoStreamGetStream ()
 Gets the underlying stream. If a stream was passed to this object then this stream is returned. Otherwise, an auto-generated stream (wrapped around the file name that was passed to this object) is returned.
FDO_API_COMMON void Write (FdoString *string)
 Writes to this text writer. The text is written in UTF8 format.
FDO_API_COMMON void WriteLine (FdoString *string)
 Same as Write(), except that a carriage return (n) is appended to the text.

Static Public Member Functions

FDO_API_COMMON FdoIoTextWriterCreate (FdoIoStream *stream)
 Constructs a text writer on a stream.
FDO_API_COMMON FdoIoTextWriterCreate (FdoString *fileName)
 Constructs a text writer on a file.

Protected Member Functions

 FdoIoTextWriter (FdoIoStream *stream)
 FdoIoTextWriter ()
 DOXYGEN-IGNORE
virtual ~FdoIoTextWriter (void)

Constructor & Destructor Documentation

FdoIoTextWriter::FdoIoTextWriter  )  [inline, protected]
 

DOXYGEN-IGNORE

Definition at line 85 of file TextWriter.h.

FdoIoTextWriter::FdoIoTextWriter FdoIoStream stream  )  [protected]
 

virtual FdoIoTextWriter::~FdoIoTextWriter void   )  [protected, virtual]
 


Member Function Documentation

FDO_API_COMMON FdoIoTextWriter* FdoIoTextWriter::Create FdoIoStream stream  )  [static]
 

Constructs a text writer on a stream.

Parameters:
stream Input the stream to write to. Writing starts at the stream's current position.
Returns:
Returns FdoIoTextWriter

FDO_API_COMMON FdoIoTextWriter* FdoIoTextWriter::Create FdoString fileName  )  [static]
 

Constructs a text writer on a file.

Parameters:
fileName Input name of the file to write to. The file is created if it does not yet exist. If it already exists, its previous contents are completely overwritten.
Returns:
Returns FdoIoTextWriter

FDO_API_COMMON FdoIoStream* FdoIoTextWriter::GetStream  ) 
 

Gets the underlying stream. If a stream was passed to this object then this stream is returned. Otherwise, an auto-generated stream (wrapped around the file name that was passed to this object) is returned.

Returns:
Returns the underlying stream.

FDO_API_COMMON void FdoIoTextWriter::Write FdoString string  ) 
 

Writes to this text writer. The text is written in UTF8 format.

Parameters:
string The text to write.

FDO_API_COMMON void FdoIoTextWriter::WriteLine FdoString string  ) 
 

Same as Write(), except that a carriage return (n) is appended to the text.

Parameters:
string The text to write.

The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.