.TH "FileByteStream" 3 "Mon Jan 12 2015" "Version dvi2bitmap1.0" "dvi2bitmap" \" -*- nroff -*-
.ad l
.nh
.SH NAME
FileByteStream \- 
.PP
An input file\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <FileByteStream\&.h>\fP
.PP
Inherits \fBInputByteStream\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBFileByteStream\fP (string &filename, string tryext='', bool preload=false)  throw (InputByteStreamError)"
.br
.RI "\fIOpens the requested file\&. \fP"
.ti -1c
.RI "\fB~FileByteStream\fP ()"
.br
.ti -1c
.RI "void \fBseek\fP (int pos)  throw (InputByteStreamError)"
.br
.RI "\fISets the position of the file pointer\&. \fP"
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
An input file\&. 


.SH "Constructor & Destructor Documentation"
.PP 
.SS "FileByteStream::FileByteStream (string &filename, stringtryext = \fC''\fP, boolpreload = \fCfalse\fP)\fBInputByteStreamError\fP"

.PP
Opens the requested file\&. If preload is true, then open the file and read it entire into memory (possibly helpful if the client will be seeking a lot)\&. If the file can't be opened, then try adding \fCtryext\fP to the end of it\&.
.PP
The file to be opened must be a seekable object -- that is, it must be a regular file, rather than a named pipe or a socket\&. The constructor checks this, and throws an exception if this is not the case\&. If you wish to open a named pipe, you can do so using \fBInputByteStream#InputByteStream(string)\fP\&.
.PP
\fBParameters:\fP
.RS 4
\fIfilename\fP the file to be opened 
.br
\fItryext\fP a file extension, including any dot, which should be added to the end of \fCfilename\fP if that cannot be opened; default \fC''\fP suppresses this 
.br
\fIpreload\fP if true, then the file is read entirely into memory
.RE
.PP
\fBExceptions:\fP
.RS 4
\fI\fBInputByteStreamError\fP\fP if there is a problem opening the file, including the discovery that it is not a seekable object 
.RE
.PP

.PP
References normal\&.
.SS "FileByteStream::~FileByteStream ()"

.SH "Member Function Documentation"
.PP 
.SS "void FileByteStream::seek (intpos)\fBInputByteStreamError\fP"

.PP
Sets the position of the file pointer\&. 
.PP
\fBParameters:\fP
.RS 4
\fIpos\fP if positive, the offset from the beginning of the file; if negative, the offset from the end of the file
.RE
.PP
\fBExceptions:\fP
.RS 4
\fI\fBInputByteStreamError\fP\fP if the offset is larger than the size of the file 
.RE
.PP

.PP
References normal\&.

.SH "Author"
.PP 
Generated automatically by Doxygen for dvi2bitmap from the source code\&.