X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2edb0bdef6238c8c246b6978bc14828b7033d931..b41f29c357205531670a156b67247b9345688150:/docs/latex/wx/ffile.tex?ds=inline diff --git a/docs/latex/wx/ffile.tex b/docs/latex/wx/ffile.tex index fd49d497bb..bfeb65e11b 100644 --- a/docs/latex/wx/ffile.tex +++ b/docs/latex/wx/ffile.tex @@ -6,7 +6,7 @@ %% Created: 14.01.02 (extracted from file.tex) %% RCS-ID: $Id$ %% Copyright: (c) Vadim Zeitlin -%% License: wxWindows license +%% License: wxWidgets license %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{\class{wxFFile}}\label{wxffile} @@ -34,6 +34,7 @@ None. \latexignore{\rtfignore{\wxheading{Members}}} + \membersection{wxFFile::wxFFile}\label{wxffileconstr} \func{}{wxFFile}{\void} @@ -62,6 +63,7 @@ for the text files.} \docparam{fp}{An existing file descriptor, such as stderr.} + \membersection{wxFFile::\destruct{wxFFile}} \func{}{\destruct{wxFFile}}{\void} @@ -70,6 +72,7 @@ Destructor will close the file. NB: it is not virtual so you should {\it not} derive from wxFFile! + \membersection{wxFFile::Attach}\label{wxffileattach} \func{void}{Attach}{\param{FILE*}{ fp}} @@ -79,18 +82,21 @@ Attaches an existing file pointer to the wxFFile object. The descriptor should be already opened and it will be closed by wxFFile object. + \membersection{wxFFile::Close}\label{wxffileclose} \func{bool}{Close}{\void} -Closes the file and returns TRUE on success. +Closes the file and returns \true on success. + \membersection{wxFFile::Detach}\label{wxffiledetach} \func{void}{Detach}{\void} -Get back a file pointer from wxFFile object - the caller is responsible for closing the file if this -descriptor is opened. \helpref{IsOpened()}{wxffileisopened} will return FALSE after call to Detach(). +Get back a file pointer from wxFFile object -- the caller is responsible for closing the file if this +descriptor is opened. \helpref{IsOpened()}{wxffileisopened} will return \false after call to Detach(). + \membersection{wxFFile::fp}\label{wxffilefp} @@ -98,29 +104,54 @@ descriptor is opened. \helpref{IsOpened()}{wxffileisopened} will return FALSE af Returns the file pointer associated with the file. + \membersection{wxFFile::Eof}\label{wxffileeof} \constfunc{bool}{Eof}{\void} -Returns TRUE if the an attempt has been made to read {\it past} +Returns \true if the an attempt has been made to read {\it past} the end of the file. Note that the behaviour of the file descriptor based class \helpref{wxFile}{wxfile} is different as \helpref{wxFile::Eof}{wxfileeof} -will return TRUE here as soon as the last byte of the file has been +will return \true here as soon as the last byte of the file has been read. +Also note that this method may only be called for opened files and may crash if +the file is not opened. + +\wxheading{See also} + +\helpref{IsOpened}{wxffileisopened} + + +\membersection{wxFFile::Error}\label{wxffileerror} + +Returns \true if an error has occured on this file, similar to the standard +\texttt{ferror()} function. + +Please note that this method may only be called for opened files and may crash +if the file is not opened. + +\wxheading{See also} + +\helpref{IsOpened}{wxffileisopened} + + \membersection{wxFFile::Flush}\label{wxffileflush} \func{bool}{Flush}{\void} -Flushes the file and returns TRUE on success. +Flushes the file and returns \true on success. + \membersection{wxFFile::IsOpened}\label{wxffileisopened} \constfunc{bool}{IsOpened}{\void} -Returns TRUE if the file has been opened. +Returns \true if the file is opened. Most of the methods of this class may only +be used for an opened file. + \membersection{wxFFile::Length}\label{wxffilelength} @@ -128,11 +159,12 @@ Returns TRUE if the file has been opened. Returns the length of the file. + \membersection{wxFFile::Open}\label{wxffileopen} \func{bool}{Open}{\param{const char*}{ filename}, \param{const char*}{ mode = "r"}} -Opens the file, returning TRUE if successful. +Opens the file, returning \true if successful. \wxheading{Parameters} @@ -140,6 +172,7 @@ Opens the file, returning TRUE if successful. \docparam{mode}{The mode in which to open the file.} + \membersection{wxFFile::Read}\label{wxffileread} \func{size\_t}{Read}{\param{void*}{ buffer}, \param{off\_t}{ count}} @@ -156,11 +189,12 @@ Reads the specified number of bytes into a buffer, returning the actual number r The number of bytes read. + \membersection{wxFFile::Seek}\label{wxffileseek} \func{bool}{Seek}{\param{long }{ofs}, \param{wxSeekMode }{mode = wxFromStart}} -Seeks to the specified position and returns TRUE on success. +Seeks to the specified position and returns \true on success. \wxheading{Parameters} @@ -168,23 +202,26 @@ Seeks to the specified position and returns TRUE on success. \docparam{mode}{One of {\bf wxFromStart}, {\bf wxFromEnd}, {\bf wxFromCurrent}.} + \membersection{wxFFile::SeekEnd}\label{wxffileseekend} \func{bool}{SeekEnd}{\param{long }{ofs = 0}} Moves the file pointer to the specified number of bytes before the end of the file -and returns TRUE on success. +and returns \true on success. \wxheading{Parameters} \docparam{ofs}{Number of bytes before the end of the file.} + \membersection{wxFFile::Tell}\label{wxffiletell} \constfunc{size\_t}{Tell}{\void} Returns the current position. + \membersection{wxFFile::Write}\label{wxffilewrite} \func{size\_t}{Write}{\param{const void*}{ buffer}, \param{size\_t}{ count}} @@ -201,13 +238,14 @@ Writes the specified number of bytes from a buffer. Number of bytes written. + \membersection{wxFFile::Write}\label{wxffilewrites} -\func{bool}{Write}{\param{const wxString\& }{s}, \param{wxMBConv\&}{ conv = wxConvLibc}} +\func{bool}{Write}{\param{const wxString\& }{s}, \param{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.