X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f3845e889c7ccfe03d034a0aa79b4f4d19fbcb06..c266eff98c5e44012647f54f38a1e29ecabd8759:/docs/latex/wx/file.tex diff --git a/docs/latex/wx/file.tex b/docs/latex/wx/file.tex index c41687fd50..316ecf7efc 100644 --- a/docs/latex/wx/file.tex +++ b/docs/latex/wx/file.tex @@ -19,6 +19,10 @@ its destructor making it unnecessary to worry about forgetting to do it. 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 is a typedef +for a native 64 bit integer, otherwise a 32 bit integer is used for wxFileOffset. + \wxheading{Derived from} None. @@ -27,6 +31,10 @@ None. +\wxheading{Library} + +\helpref{wxBase}{librarieslist} + \wxheading{Constants} wx/file.h defines the following constants: @@ -70,7 +78,7 @@ Will fail if the file already exists, else create and open it atomically. Usefu \end{twocollist} Other constants defined elsewhere but used by wxFile functions are wxInvalidOffset which represents an -invalid value of type {\it off\_t} and is returned by functions returning {\it off\_t} on error and the seek +invalid value of type {\it wxFileOffset} and is returned by functions returning {\it wxFileOffset} on error and the seek mode constants used with \helpref{Seek()}{wxfileseek}: \twocolwidtha{7cm} @@ -82,13 +90,14 @@ mode constants used with \helpref{Seek()}{wxfileseek}: \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxFile::wxFile}\label{wxfileconstr} + +\membersection{wxFile::wxFile}\label{wxfilector} \func{}{wxFile}{\void} 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 @@ -107,21 +116,24 @@ Associates the file with the given file descriptor, which has already been opene \docparam{fd}{An existing file descriptor (see \helpref{Attach()}{wxfileattach} for the list of predefined descriptors)} -\membersection{wxFile::\destruct{wxFile}} + +\membersection{wxFile::\destruct{wxFile}}\label{wxfiledtor} \func{}{\destruct{wxFile}}{\void} Destructor will close the file. -NB: it is not virtual so you should use wxFile polymorphically. +{\bf NB:} it is not virtual so you should not use wxFile polymorphically. + \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. + \membersection{wxFile::Attach}\label{wxfileattach} \func{void}{Attach}{\param{int}{ fd}} @@ -133,25 +145,29 @@ have symbolic names of {\bf wxFile::fd\_stdin}, {\bf wxFile::fd\_stdout} and {\b The descriptor should be already opened and it will be closed by wxFile object. + \membersection{wxFile::Close}\label{wxfileclose} \func{void}{Close}{\void} 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 +Creates a file for writing. If the file already exists, setting {\bf overwrite} to true will ensure it is overwritten. + \membersection{wxFile::Detach}\label{wxfiledetach} \func{void}{Detach}{\void} Get back a file descriptor from wxFile object - the caller is responsible for closing the file if this -descriptor is opened. \helpref{IsOpened()}{wxfileisopened} will return FALSE after call to Detach(). +descriptor is opened. \helpref{IsOpened()}{wxfileisopened} will return false after call to Detach(). + \membersection{wxFile::fd}\label{wxfilefd} @@ -159,16 +175,17 @@ descriptor is opened. \helpref{IsOpened()}{wxfileisopened} will return FALSE aft Returns the file descriptor associated with the file. + \membersection{wxFile::Eof}\label{wxfileeof} \constfunc{bool}{Eof}{\void} -Returns TRUE if the end of the file has been reached. +Returns true if the end of the file has been reached. Note that the behaviour of the file pointer based class \helpref{wxFFile}{wxffile} is different as \helpref{wxFFile::Eof}{wxffileeof} -will return TRUE here only if an attempt has been made to read -{\it past} the last byte of the file, while wxFile::Eof() will return TRUE +will return true here only if an attempt has been made to read +{\it past} the last byte of the file, while wxFile::Eof() will return true even before such attempt is made if the file pointer is at the last position in the file. @@ -179,13 +196,15 @@ file into memory, you should write a loop which uses \helpref{Read}{wxfileread} repeatedly and tests its return condition instead 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 +Returns true if the given name specifies an existing regular file (not a directory or a link) + \membersection{wxFile::Flush}\label{wxfileflush} \func{bool}{Flush}{\void} @@ -196,23 +215,44 @@ Note that wxFile::Flush is not implemented on some Windows compilers due to a missing fsync function, which reduces the usefulness of this function (it can still be called but it will do nothing on unsupported compilers). + +\membersection{wxFile::GetKind}\label{wxfilegetfilekind} + +\constfunc{wxFileKind}{GetKind}{\void} + +Returns the type of the file. Possible return values are: + +\begin{verbatim} +enum wxFileKind +{ + wxFILE_KIND_UNKNOWN, + wxFILE_KIND_DISK, // a file supporting seeking to arbitrary offsets + wxFILE_KIND_TERMINAL, // a tty + wxFILE_KIND_PIPE // a pipe +}; + +\end{verbatim} + + \membersection{wxFile::IsOpened}\label{wxfileisopened} \constfunc{bool}{IsOpened}{\void} -Returns TRUE if the file has been opened. +Returns true if the file has been opened. + \membersection{wxFile::Length}\label{wxfilelength} -\constfunc{off\_t}{Length}{\void} +\constfunc{wxFileOffset}{Length}{\void} 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. +Opens the file, returning true if successful. \wxheading{Parameters} @@ -220,9 +260,10 @@ Opens the file, returning TRUE if successful. \docparam{mode}{The mode in which to open the file. May be one of {\bf wxFile::read}, {\bf wxFile::write} and {\bf wxFile::read\_write}.} + \membersection{wxFile::Read}\label{wxfileread} -\func{off\_t}{Read}{\param{void*}{ buffer}, \param{off\_t}{ count}} +\func{size\_t}{Read}{\param{void*}{ buffer}, \param{size\_t}{ count}} Reads the specified number of bytes into a buffer, returning the actual number read. @@ -236,9 +277,10 @@ Reads the specified number of bytes into a buffer, returning the actual number r The number of bytes read, or the symbol {\bf wxInvalidOffset} (-1) if there was an error. + \membersection{wxFile::Seek}\label{wxfileseek} -\func{off\_t}{Seek}{\param{off\_t }{ofs}, \param{wxSeekMode }{mode = wxFromStart}} +\func{wxFileOffset}{Seek}{\param{wxFileOffset }{ofs}, \param{wxSeekMode }{mode = wxFromStart}} Seeks to the specified position. @@ -252,11 +294,14 @@ Seeks to the specified position. The actual offset position achieved, or wxInvalidOffset on failure. + \membersection{wxFile::SeekEnd}\label{wxfileseekend} -\func{off\_t}{SeekEnd}{\param{off\_t }{ofs = 0}} +\func{wxFileOffset}{SeekEnd}{\param{wxFileOffset }{ofs = 0}} -Moves the file pointer to the specified number of bytes before the end of the file. +Moves the file pointer to the specified number of bytes relative to the end of +the file. For example, \texttt{SeekEnd($-5$)} would position the pointer $5$ +bytes before the end. \wxheading{Parameters} @@ -266,16 +311,18 @@ Moves the file pointer to the specified number of bytes before the end of the fi The actual offset position achieved, or wxInvalidOffset on failure. + \membersection{wxFile::Tell}\label{wxfiletell} -\constfunc{off\_t}{Tell}{\void} +\constfunc{wxFileOffset}{Tell}{\void} Returns the current position or wxInvalidOffset if file is not opened or if another error occurred. + \membersection{wxFile::Write}\label{wxfilewrite} -\func{size\_t}{Write}{\param{const void*}{ buffer}, \param{off\_t}{ count}} +\func{size\_t}{Write}{\param{const void*}{ buffer}, \param{size\_t}{ count}} Writes the specified number of bytes from a buffer. @@ -289,12 +336,17 @@ Writes the specified number of bytes from a buffer. the number of bytes actually written + \membersection{wxFile::Write}\label{wxfilewrites} -\func{bool}{Write}{\param{const wxString\& }{s}, \param{wxMBConv&}{ conv = wxConvLibc}} +\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. +Writes the contents of the string to the file, returns true on success. -The second argument is only meaningful in Unicode build of wxWindows when +The second argument is only meaningful in Unicode build of wxWidgets when {\it conv} is used to convert {\it s} to multibyte representation. +Note that this method only works with {\tt NUL}-terminated strings, if you want +to write data with embedded {\tt NUL}s to the file you should use the other +\helpref{Write() overload}{wxfilewrite}. +