X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3d971ca9f1b59d2cda15569b7d87adbfec4e0475..c266eff98c5e44012647f54f38a1e29ecabd8759:/docs/latex/wx/file.tex diff --git a/docs/latex/wx/file.tex b/docs/latex/wx/file.tex index bc58192219..316ecf7efc 100644 --- a/docs/latex/wx/file.tex +++ b/docs/latex/wx/file.tex @@ -20,8 +20,8 @@ wxFile is a wrapper around {\tt file descriptor.} - see also \helpref{wxFFile}{wxffile} for a wrapper around {\tt FILE} structure. {\tt wxFileOffset} is used by the wxFile functions which require offsets as -parameter or return them. If the platform supports it, wxFileOffset if a typedef -for a native 64 bit integer, else a 32 bit integer is used for wxFileOffset. +parameter or return them. If the platform supports it, wxFileOffset is a typedef +for a native 64 bit integer, otherwise a 32 bit integer is used for wxFileOffset. \wxheading{Derived from} @@ -31,6 +31,10 @@ None. +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{Constants} wx/file.h defines the following constants: @@ -93,7 +97,7 @@ mode constants used with \helpref{Seek()}{wxfileseek}: Default constructor. -\func{}{wxFile}{\param{const char*}{ filename}, \param{wxFile::OpenMode}{ mode = wxFile::read}} +\func{}{wxFile}{\param{const wxString\&}{ filename}, \param{wxFile::OpenMode}{ mode = wxFile::read}} Opens a file with the given mode. As there is no way to return whether the operation was successful or not from the constructor you should test the @@ -124,7 +128,7 @@ Destructor will close the file. \membersection{wxFile::Access}\label{wxfileaccess} -\func{static bool}{Access}{\param{const char *}{ name}, \param{OpenMode}{ mode}} +\func{static bool}{Access}{\param{const wxString\&}{ name}, \param{OpenMode}{ mode}} This function verifies if we may access the given file in specified mode. Only values of wxFile::read or wxFile::write really make sense here. @@ -151,7 +155,7 @@ Closes the file. \membersection{wxFile::Create}\label{wxfilecreate} -\func{bool}{Create}{\param{const char*}{ filename}, \param{bool}{ overwrite = false}, \param{int }{access = wxS\_DEFAULT}} +\func{bool}{Create}{\param{const wxString\&}{ filename}, \param{bool}{ overwrite = false}, \param{int }{access = wxS\_DEFAULT}} Creates a file for writing. If the file already exists, setting {\bf overwrite} to true will ensure it is overwritten. @@ -195,7 +199,7 @@ of using Eof() as this will not work for special files under Unix. \membersection{wxFile::Exists}\label{wxfileexists} -\func{static bool}{Exists}{\param{const char*}{ filename}} +\func{static bool}{Exists}{\param{const wxString\&}{ filename}} Returns true if the given name specifies an existing regular file (not a directory or a link) @@ -246,7 +250,7 @@ Returns the length of the file. \membersection{wxFile::Open}\label{wxfileopen} -\func{bool}{Open}{\param{const char*}{ filename}, \param{wxFile::OpenMode}{ mode = wxFile::read}} +\func{bool}{Open}{\param{const wxString\&}{ filename}, \param{wxFile::OpenMode}{ mode = wxFile::read}} Opens the file, returning true if successful. @@ -335,7 +339,7 @@ the number of bytes actually written \membersection{wxFile::Write}\label{wxfilewrites} -\func{bool}{Write}{\param{const wxString\& }{s}, \param{wxMBConv\&}{ conv = wxConvUTF8}} +\func{bool}{Write}{\param{const wxString\& }{s}, \param{const wxMBConv\&}{ conv = wxConvUTF8}} Writes the contents of the string to the file, returns true on success.