ITxtExpFileWriter Class Reference

#include <ITxtExpFileWriter.h>

Inheritance diagram for ITxtExpFileWriter:

Public Types
enum	Encoding {   kTxtExpEncodingInvalid = -1, kTxtExpEncodingASCII, kTxtExpEncodingUNICODE, kTxtExpEncodingShiftJIS,   kTxtExpEncodingJIS, kTxtExpEncodingEUC }
enum	{ kDefaultIID = IID_ITXTEXPFILEWRITER }

Public Member Functions
virtual int32	WriteTextCharBuffer (IPMStream *stream, const textchar *tcbuf, const int32 bufSize)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

From SDK sample; interface to help write characters to a text file. To implement ITxtExpFileWriter, you can use the partial implementation, CTxtExpFileWriter, which is also part of this sample.

Member Enumeration Documentation

enum ITxtExpFileWriter::Encoding

Options for the various types of Japanese/Roman text file encodings.

Enumerator
kTxtExpEncodingInvalid	-1
kTxtExpEncodingASCII	0
kTxtExpEncodingUNICODE	1
kTxtExpEncodingShiftJIS	2
kTxtExpEncodingJIS	3
kTxtExpEncodingEUC	4 (not supported)

Member Function Documentation

virtual int32 ITxtExpFileWriter::WriteTextCharBuffer ( IPMStream *  stream, const textchar *  tcbuf, const int32  bufSize  )

pure virtual

Writes the textchar data to the given file stream.

Parameters

stream	Stream to write to.
tcbuf	Pointer to a buffer of textchars to write.
bufSize	Number of textchars to write.

Returns

Number of textchars (not bytes) written to stream.

Implemented in JISFileWriter, CTxtExpFileWriter, UNICODEFileWriter, ShiftJISFileWriter, and ASCIIFileWriter.