RWUCharOutputStream

Module:  Advanced Tools   Package:  Streams

RWUCharOutputStream  RWHandleBase

• Local Index
• Header File
• Description
• Public Constructors
• Public Operators
• Public Member Functions
• Related Global Functions

Members

close() flush() isBad()

isFail() isGood() operator<<()

operator=() RWUCharOutputStream() write()

Non-Members

rwEndl()

rwEnds()

rwFlush()

#include <rw/stream/RWUCharOutputStream.h>

Handle class for all the Unicode character output stream implementation classes. Implements the handle idiom from the handle-body pattern.

RW_EXPLICIT
RWUCharOutputStream(RWUCharOutputStreamImp* body);

Constructor.

RWUCharOutputStream(const RWUCharOutputStream& handle) 
    :RWHandleBase(handle);

Copy constructor.

Parameter List

handle

A UTF-16 character stream handle used to initialize the newly created handle.

RWUCharOutputStream 
operator<<(RWUCharOutputStream (*pf)(RWUCharOutputStream&));

Inserter executing a manipulator function.

Parameter List

pf	The manipulator's function pointer.

RWUCharOutputStream& 
operator<<(RWUChar unicodeValue);

Writes a single UTF-16 character to the stream.

Parameter List

unicodeValue

The UTF-16 character to be written to the stream.

RWUCharOutputStream& 
operator<<(RWUCharOutputStream& (*pf)(RWUCharOutputStream&));

Inserter executing a manipulator function.

Parameter List

pf	The manipulator's function pointer.

RWUCharOutputStream& 
operator=(const RWUCharOutputStream& handle);

Assignment operator. Throws no exceptions.

Parameter List

handle

A UTF-16 character stream handle used to initialize this handle.

void 
close();

Closes the stream.

void 
flush();

Flushes the stream.

bool 
isBad() const;

Returns true to indicate a loss of integrity resulting from an output operation. Throws no exceptions.

bool 
isFail() const;

Returns true to indicate that an output operation failed to generate the desired data. Throws no exceptions.

bool 
isGood() const;

Returns true to indicate a stream in a valid state. Throws no exceptions.

void 
write(RWUChar unicodeValue);

Writes a single UTF-16 character to the stream.

Parameter List

unicodeValue

The UTF-16 character to be written to the stream.

void 
write(const RWUChar* unicodeArray, RWSize numUChars);

Writes an array of UTF-16 characters to the stream.

Parameter List

unicodeArray	A pointer to the first element of the array.
numUChars	The number of UTF-16 characters to be written to the stream.

RWUCharOutputStream& 
rwEndl(RWUCharOutputStream& stream);

Manipulator that writes an end-of-line UTF-16 control character to the stream.

Parameter List

stream

A UTF-16 character output stream.

RWUCharOutputStream& 
rwEnds(RWUCharOutputStream& stream);

Manipulator that writes an end-of-string UTF-16 character to the stream.

Parameter List

stream

A UTF-16 character output stream.

RWUCharOutputStream& 
rwFlush(RWUCharOutputStream& stream);

Manipulator that flushes a UTF-16 character output stream.

Parameter List

stream

The UTF-16 character stream to be flushed.

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.