.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxOutputStream 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxOutputStream \- 
  Output stream class
 
.SH DESCRIPTION

  


   wxOutputStream is an abstract base class which may not be used directly.
  
 
.SH "PARENTS"

  wxStreamBase
 
.SH "INCLUDE FILES"
wx/stream.h
.SH MEMBERS

  
.SS  wxOutputStream ()

     


      Creates a dummy wxOutputStream object.
     
    
   
  
.SS  ~wxOutputStream ()

     


      Destructor.
     
    
   
  
.SS bool Close ()

     


      Closes the stream, returning
      false
      if an error occurs. The stream is closed implicitly in the destructor if
      Close() is not called explicitly.
     
     


      If this stream wraps another stream or some other resource such as a file,
      then the underlying resource is closed too if it is owned by this stream,
      or left open otherwise.
     
    
   
  
.SS size_t LastWrite ()

     


      Returns the number of bytes written during the last
      Write()
      . It may return 0 even if there is no error on the stream if it is only
      temporarily impossible to write to it.
     
    
   
  
.SS void PutC (char c)

     


      Puts the specified character in the output queue and increments the stream
      position.
     
    
   
  
.SS off_t SeekO (off_t poswxSeekMode mode = wxFromStart)

     


      Changes the stream current position.
     
    
   
  
.SS off_t TellO ()

     


      Returns the current stream position.
     
    
   
  
.SS wxOutputStream& Write (const void *buffersize_t size)

     


      Writes up to the specified amount of bytes using the data of
      
       buffer
      
      . Note that not all data can always be written so you must check the
      number of bytes really written to the stream using
      LastWrite()
      when this function returns. In some cases (for example a write end of a
      pipe which is currently full) it is even possible that there is no errors
      and zero bytes have been written.
     
     


      This function returns a reference on the current object, so the user can
      test any states of the stream right away.
     
    
.SS wxOutputStream& Write (wxInputStream& stream_in)

     


      Reads data from the specified input stream and stores them in the current
      stream. The data is read until an error is raised by one of the two
      streams.
     
    
 
.SH "SEE ALSO"

  wxStreamBase
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.