SourcePro® API Reference Guide

 
Loading...
Searching...
No Matches
RWIncompleteStreamOperation Class Reference

Reports errors due to an incomplete stream operation. More...

#include <rw/stream/RWIncompleteStreamOperation.h>

Inheritance diagram for RWIncompleteStreamOperation:
RWExternalStreamException RWExternalErr RWxmsg

Public Member Functions

 RWIncompleteStreamOperation ()
 
 RWIncompleteStreamOperation (const char *msg, ErrorCode err, RWSize partial)
 
 RWIncompleteStreamOperation (const RWCString &msg, ErrorCode err, RWSize partial)
 
 RWIncompleteStreamOperation (const RWIncompleteStreamOperation &x)
 
RWSize elementsProcessed () const
 
- Public Member Functions inherited from RWExternalStreamException
 RWExternalStreamException ()
 
 RWExternalStreamException (const char *msg, ErrorCode err)
 
 RWExternalStreamException (const RWCString &msg, ErrorCode err)
 
 RWExternalStreamException (const RWExternalStreamException &x)
 
ErrorCode errorCode () const
 
- Public Member Functions inherited from RWxmsg
 RWxmsg (const char *msg)
 
 RWxmsg (const RWxmsg &msg)
 
 RWxmsg (RWxmsg &&msg)
 
RWxmsgoperator= (const RWxmsg &)
 
RWxmsgoperator= (RWxmsg &&msg)
 
virtual void raise () const
 
void swap (RWxmsg &rhs)
 
virtual const char * why () const
 

Additional Inherited Members

- Public Types inherited from RWExternalStreamException
enum  ErrorCode {
  ok , flush , write , read ,
  get , internalOstream , internalIstream , featureNotSupported ,
  outOfMemory , invalidParameter , invalidUnicodeEncoding , invalidUTF8Encoding
}
 
- Protected Member Functions inherited from RWxmsg
 RWxmsg (const char *msg, bool doCopy)
 

Detailed Description

Exception class used to report an error due to a stream operation partially fulfilled.

Constructor & Destructor Documentation

◆ RWIncompleteStreamOperation() [1/4]

RWIncompleteStreamOperation::RWIncompleteStreamOperation ( )

Constructs an empty exception. Throws no exceptions.

◆ RWIncompleteStreamOperation() [2/4]

RWIncompleteStreamOperation::RWIncompleteStreamOperation ( const char * msg,
ErrorCode err,
RWSize partial )

Constructs an exception, and initializes it with the error message msg, the error code err, and the partial result partial.

Parameters
msgMessage describing the error.
errError code associated with the error.
partialNumber of elements successfully processed.

◆ RWIncompleteStreamOperation() [3/4]

RWIncompleteStreamOperation::RWIncompleteStreamOperation ( const RWCString & msg,
ErrorCode err,
RWSize partial )

Constructs an exception, and initializes it with the error message msg, the error code err, and the partial result partial.

Parameters
msgMessage describing the error.
errError code associated with the error.
partialNumber of elements successfully processed.

◆ RWIncompleteStreamOperation() [4/4]

RWIncompleteStreamOperation::RWIncompleteStreamOperation ( const RWIncompleteStreamOperation & x)

Copy constructor.

Parameters
xAn exception used to initialize the newly created exception.

Member Function Documentation

◆ elementsProcessed()

RWSize RWIncompleteStreamOperation::elementsProcessed ( ) const

Returns the number of elements successfully processed before the error occurred. Throws no exceptions.

Copyright © 2024 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved.