X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6bcfd974ef26faf6f91a62cac09827e09463fd1..b0ee47ff76c278c053ac2ad36bb3129b0fcd050f:/docs/latex/wx/file.tex diff --git a/docs/latex/wx/file.tex b/docs/latex/wx/file.tex index ac45262df2..fa8a9c8bdf 100644 --- a/docs/latex/wx/file.tex +++ b/docs/latex/wx/file.tex @@ -278,10 +278,13 @@ the number of bytes actually written \membersection{wxFile::Write}\label{wxfilewrites} -\func{bool}{Write}{\param{const wxString\& }{s}} +\func{bool}{Write}{\param{const wxString\& }{s}, \param{wxMBConv&}{ conv = wxConvLibc}} 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 +{\it conv} is used to convert {\it s} to multibyte representation. + \section{\class{wxFFile}}\label{wxffile} wxFFile implements buffered file I/O. This is a very small class designed to @@ -328,7 +331,10 @@ Opens a file with the given file pointer, which has already been opened. \docparam{filename}{The filename.} -\docparam{mode}{The mode in which to open the file using standard C strings.} +\docparam{mode}{The mode in which to open the file using standard C strings. +Note that you should use {\tt "b"} flag if you use binary files under Windows +or the results might be unexpected due to automatic newline conversion done +for the text files.} \docparam{fp}{An existing file descriptor, such as stderr.} @@ -473,7 +479,9 @@ Number of bytes written. \membersection{wxFFile::Write}\label{wxffilewrites} -\func{bool}{Write}{\param{const wxString\& }{s}} +\func{bool}{Write}{\param{const wxString\& }{s}, \param{wxMBConv&}{ conv = wxConvLibc}} 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 +{\it conv} is used to convert {\it s} to multibyte representation.