X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6bcfd974ef26faf6f91a62cac09827e09463fd1..52ee226853ec422d1517de38a0fa76d866c37153:/docs/latex/wx/tempfile.tex diff --git a/docs/latex/wx/tempfile.tex b/docs/latex/wx/tempfile.tex index 4fe80189c9..343a3ea55d 100644 --- a/docs/latex/wx/tempfile.tex +++ b/docs/latex/wx/tempfile.tex @@ -65,32 +65,41 @@ Associates wxTempFile with the file to be replaced and opens it. You should use \func{bool}{Open}{\param{const wxString\& }{strName}} -Open the temporary file (strName is the name of file to be replaced), returns -TRUE on success, FALSE if an error occurred. +Open the temporary file, returns {\tt TRUE} on success, {\tt FALSE} if an error +occurred. + +{\it strName} is the name of file to be replaced. The temporary file is always +created in the directory where {\it strName} is. In particular, if +{\it strName} doesn't include the path, it is created in the current directory +and the program should have write access to it for the function to succeed. \membersection{wxTempFile::IsOpened}\label{wxtempfileisopened} + \constfunc{bool}{IsOpened}{\void} -Returns TRUE if the file was successfully opened. +Returns {\tt TRUE} if the file was successfully opened. \membersection{wxTempFile::Write}\label{wxtempfilewrite} \func{bool}{Write}{\param{const void }{*p}, \param{size\_t }{n}} -Write to the file, return TRUE on success, FALSE on failure. +Write to the file, return {\tt TRUE} on success, {\tt FALSE} on failure. \membersection{wxTempFile::Write}\label{wxtempfilewrites} -\func{bool}{Write}{\param{const wxString\& }{str}} +\func{bool}{Write}{\param{const wxString\& }{str}, \param{wxMBConv\&}{ conv = wxConvLibc}} + +Write to the file, return {\tt TRUE} on success, {\tt FALSE} on failure. -Write to the file, return TRUE on success, FALSE on failure. +The second argument is only meaningful in Unicode build of wxWindows when +{\it conv} is used to convert {\it str} to multibyte representation. \membersection{wxTempFile::Commit}\label{wxtempfilecommit} \func{bool}{Commit}{\void} Validate changes: deletes the old file of name m\_strName and renames the new -file to the old name. Returns TRUE if both actions succeeded. If FALSE is +file to the old name. Returns {\tt TRUE} if both actions succeeded. If {\tt FALSE} is returned it may unfortunately mean two quite different things: either that either the old file couldn't be deleted or that the new file couldn't be renamed to the old name.