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

  


   This class is the base class of most stream related classes in wxWidgets. It
   must not be used directly.
  
 
.SH "PARENTS"

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

  
.SS  wxStreamBase ()

     


      Creates a dummy stream object. It doesn't do anything.
     
    
   
  
.SS  ~wxStreamBase ()

     


      Destructor.
     
    
   
  
.SS wxFileOffset GetLength ()

     


      Returns the length of the stream in bytes. If the length cannot be
      determined (this is always the case for socket streams for example),
      returns
      wxInvalidOffset
      .
     
     


      \newsince{2.5.4}
     
    
   
  
.SS wxStreamError GetLastError ()

     


      This function returns the last error.
     
     
      
       
        
         wxSTREAM_NO_ERROR
        
       
       
        No error occurred.
       
      

       
      
       
        
         wxSTREAM_EOF
        
       
       
        An End-Of-File occurred.
       
      

       
      
       
        
         wxSTREAM_WRITE_ERROR
        
       
       
        A generic error occurred on the last write call.
       
      

       
      
       
        
         wxSTREAM_READ_ERROR
        
       
       
        A generic error occurred on the last read call.
       
      

     
    
   
  
.SS size_t GetSize ()

     


      GetLength
     
     


      This function returns the size of the stream. For example, for a file it
      is the size of the file.
     
    
   
  
.SS bool IsOk ()

     


      Returns true if no error occurred on the stream.
     
    
   
  
.SS bool IsSeekable ()

     


      Returns true if the streams supports seeking to arbitrary offsets.
     
    
   
  
.SS size_t OnSysRead (void* buffersize_t bufsize)

     


      Internal function. It is called when the stream wants to read data of the
      specified size. It should return the size that was actually read.
     
    
   
  
.SS off_t OnSysSeek (off_t poswxSeekMode mode)

     


      Internal function. It is called when the stream needs to change the
      current position.
     
    
   
  
.SS off_t OnSysTell ()

     


      Internal function. Is is called when the stream needs to know the real
      position.
     
    
   
  
.SS size_t OnSysWrite (void *buffersize_t bufsize)

     


      See
      OnSysRead
      .
     
    
 
.SH "SEE ALSO"

  wxStreamBuffer
 
.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.