X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0912690b65b3c58c0e12870fb971675ca5572ae6..43f06cfda107a4a74776b58dca3353a4414ecfb1:/docs/latex/wx/ffile.tex diff --git a/docs/latex/wx/ffile.tex b/docs/latex/wx/ffile.tex index 3db99c9ffd..fafe340746 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: wxWidgets license +%% License: wxWindows license %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \section{\class{wxFFile}}\label{wxffile} @@ -127,7 +127,7 @@ the file is not opened. \membersection{wxFFile::Error}\label{wxffileerror} -Returns \true if an error has occured on this file, similar to the standard +Returns \true if an error has occurred 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 @@ -208,6 +208,24 @@ Reads the specified number of bytes into a buffer, returning the actual number r The number of bytes read. +\membersection{wxFFile::ReadAll}\label{wxffilereadall} + +\func{bool}{ReadAll}{\param{wxString *}{ str}, \param{wxMBConv\&}{ conv = wxConvUTF8}} + +Reads the entire contents of the file into a string. + +\wxheading{Parameters} + +\docparam{str}{String to read data into.} + +\docparam{conv}{Conversion object to use in Unicode build; by default supposes +that file contents is encoded in UTF-8.} + +\wxheading{Return value} + +\true if file was read successfully, \false otherwise. + + \membersection{wxFFile::Seek}\label{wxffileseek} \func{bool}{Seek}{\param{wxFileOffset }{ofs}, \param{wxSeekMode }{mode = wxFromStart}}