SourcePro® 2023.1 |
SourcePro® API Reference Guide |
Handle class for all the wide character input stream implementation classes. More...
#include <rw/stream/RWWCharInputStream.h>
Public Member Functions | |
RWWCharInputStream (RWWCharInputStreamImp *ptr) | |
RWWCharInputStream (const RWWCharInputStream &handle) | |
RWSize | available () const |
void | close () |
bool | isBad () const |
bool | isEof () const |
bool | isFail () const |
bool | isGood () const |
RWWCharInputStream & | operator= (const RWWCharInputStream &handle) |
RWWCharInputStream & | operator>> (RWWCharInputStream &(*pf)(RWWCharInputStream &)) |
RWWCharInputStream | operator>> (RWWCharInputStream(*pf)(RWWCharInputStream &)) |
RWWCharInputStream & | operator>> (wchar_t &wcharValue) |
wchar_t | read () |
RWSize | read (wchar_t *wcharArray, RWSize numWChars) |
RWSize | readUntil (wchar_t *wcharArray, RWSize maxSize, wchar_t delim) |
RWSize | skip (RWSize numUnits) |
Public Member Functions inherited from RWHandleBase | |
bool | isValid (void) const |
bool | operator!= (const RWHandleBase &second) const |
bool | operator< (const RWHandleBase &second) const |
bool | operator== (const RWHandleBase &second) const |
Related Functions | |
(Note that these are not member functions.) | |
RWWCharInputStream & | rwDisc (RWWCharInputStream &stream) |
RWWCharInputStream | rwGuard (RWWCharInputStream &stream) |
Additional Inherited Members | |
Protected Member Functions inherited from RWHandleBase | |
RWHandleBase (void) | |
RWHandleBase (RWStaticCtor) | |
RWHandleBase (RWBodyBase *body) | |
RWHandleBase (const RWHandleBase &second) | |
~RWHandleBase (void) | |
RWBodyBase & | body (void) const |
RWHandleBase & | operator= (const RWHandleBase &second) |
Handle class for all the wide character input stream implementation classes. Implements the handle idiom from the handle-body pattern.
|
inlineexplicit |
Constructor.
|
inline |
Copy constructor.
handle | A wide character stream handle used to initialize the newly created handle. |
|
inline |
Returns the number of wide characters that can be read from the stream without blocking. Throws no exceptions.
|
inline |
Closes the stream.
|
inline |
Returns true
to indicate a loss of integrity resulting from an input operation, such as an irrecoverable read error from a file. Throws no exceptions.
|
inline |
Returns true
to indicate that an input operation reached the end of an input sequence. Throws no exceptions.
|
inline |
Returns true
to indicate that an input operation failed to read the expected data. Throws no exceptions.
|
inline |
Returns true
to indicate a stream in a valid state. Throws no exceptions.
|
inline |
Assignment operator. Throws no exceptions.
handle | A wide character stream handle used to initialize this handle. |
|
inline |
Extractor executing a manipulator function.
pf | The manipulator's function pointer. |
|
inline |
Extractor executing a manipulator function.
pf | The manipulator's function pointer. |
|
inline |
Reads a single wide character from the stream.
wcharValue | The wide character to be read from the stream. |
|
inline |
Reads a single wide character from the stream.
Reads an array of wide characters from the stream. The array must be pre-allocated to contain at least numWChars elements. The function returns the actual number of wide characters extracted from the stream.
wcharArray | A pointer to the first element of the array. |
numWChars | The number of wide characters to be read from the stream. |
Reads wide characters from the stream until the last wide character read is equal to delim, or maxSize wide characters have been read, or the end of the input sequence is reached. The wide characters read are stored in wcharArray. The function returns the actual number of wide characters read from the stream.
wcharArray | A pointer to the array receiving the wide characters extracted from the stream. |
maxSize | The maximum number of wide characters to be read. |
delim | The wide character used as a delimiter. |
Skips numUnits wide characters from the input sequence if possible. The function returns the actual number of wide characters skipped, which can be any value between 0
and numUnits.
numUnits | The number of wide characters to be skipped. |
|
related |
Manipulator that discards a narrow character from a stream input sequence.
stream | The wide character stream. |
|
related |
Manipulator that is used to guard a series of extraction operations.
stream | A wide character input stream. |
A rwGuard() manipulator creates a temporary guarded stream that locks the internal mutex of the preceding synchronized stream. In this way, any extractions following the manipulator within the statement will be atomic, that is, uninterrupted by any other threads. Note that if the preceding stream is not a synchronized stream, the rwGuard() manipulator has no effect.
Copyright © 2023 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved. |