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

  


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

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

  
.SS  wxInputStream ()

     


      Creates a dummy input stream.
     
    
   
  
.SS  ~wxInputStream ()

     


      Destructor.
     
    
   
  
.SS bool CanRead ()

     


      Returns true if some data is available in the stream right now, so that
      calling
      Read()
      wouldn't block.
     
    
   
  
.SS char GetC ()

     


      Returns the first character in the input queue and removes it, blocking
      until it appears if necessary.
     
    
   
  
.SS bool Eof ()

     


      Returns true if the end of stream has been reached.
     
    
   
  
.SS size_t LastRead ()

     


      Returns the last number of bytes read.
     
    
   
  
.SS char Peek ()

     


      Returns the first character in the input queue without removing it.
     
    
   
  
.SS wxInputStream& Read (void *buffersize_t size)

     


      Reads the specified amount of bytes and stores the data in
      
       buffer
      
      .
     
    
.SS wxInputStream& Read (wxOutputStream& stream_out)

     


      Reads data from the input queue and stores it in the specified output
      stream. The data is read until an error is raised by one of the two
      streams.
     
    
   
  
.SS off_t SeekI (off_t poswxSeekMode mode = wxFromStart)

     


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

     


      Returns the current stream position.
     
    
   
  
.SS size_t Ungetch (const char* buffersize_t size)

     


      This function is only useful in
      
       read
      
      mode. It is the manager of the "Write-Back" buffer. This buffer
      acts like a temporary buffer where data which has to be read during the
      next read IO call are put. This is useful when you get a big block of data
      which you didn't want to read: you can replace them at the top of the
      input queue by this way.
     
     


      Be very careful about this call in connection with calling SeekI() on the
      same stream. Any call to SeekI() will invalidate any previous call to this
      method (otherwise you could SeekI() to one position, "unread" a
      few bytes there, SeekI() to another position and data would be either lost
      or corrupted).
     
    
.SS bool Ungetch (char c)

     


      This function acts like the previous one except that it takes only one
      character: it is sometimes shorter to use than the generic function.
     
    
 
.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.