]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/filesys.tex
Remove const bool
[wxWidgets.git] / docs / latex / wx / filesys.tex
index 2d38e300a553a24c45a2c9d8d33ce1f3a8b1613f..091c52217453238c1f1344dc99a557d9ec25149f 100644 (file)
@@ -118,7 +118,7 @@ Converts filename into URL.
 
 \membersection{wxFileSystem::FindFileInPath}\label{wxfilesystemfindfileinpath}
 
-\func{bool}{FindFileInPath}{\param{wxString }{*str}, \param{const wxChar }{*path}, \param{const wxChar }{*file}}
+\func{bool}{FindFileInPath}{\param{wxString }{*str}, \param{const wxString\& }{path}, \param{const wxString\& }{file}}
 
 Looks for the file with the given name \arg{file} in a colon or semi-colon
 (depending on the current platform) separated list of directories in
@@ -153,7 +153,7 @@ Returns the next filename that matches parameters passed to \helpref{FindFirst}{
 
 \membersection{wxFileSystem::OpenFile}\label{wxfilesystemopenfile}
 
-\func{wxFSFile*}{OpenFile}{\param{const wxString\& }{location}}
+\func{wxFSFile*}{OpenFile}{\param{const wxString\& }{location}, \param{int }{flags = wxFS\_READ}}
 
 Opens the file and returns a pointer to a \helpref{wxFSFile}{wxfsfile} object
 or NULL if failed. It first tries to open the file in relative scope
@@ -161,6 +161,22 @@ or NULL if failed. It first tries to open the file in relative scope
 absolute path.  Note that the user is responsible for deleting the returned
 wxFSFile.  
 
+{\it flags} can be one or more of the following bit values ored together:
+
+\begin{verbatim}
+// Open Bit Flags
+enum {
+    wxFS_READ = 1,      // Open for reading
+    wxFS_SEEKABLE = 4   // Returned stream will be seekable
+};
+\end{verbatim}
+
+A stream opened with just the default {\it wxFS\_READ} flag may
+or may not be seekable depending on the underlying source.
+Passing {\it wxFS\_READ | wxFS\_SEEKABLE} for {\it flags} will
+back a stream that is not natively seekable with memory or a file
+and return a stream that is always seekable.
+
 
 \membersection{wxFileSystem::URLToFileName}\label{wxfilesystemurltofilename}