1 % automatically generated by HelpGen from tempfile.tex at 10/Jan/99 19:24:44
2 \section{\class{wxTempFile
}}\label{wxtempfile
}
4 wxTempFile provides a relatively safe way to replace the contents of the
5 existing file. The name is explained by the fact that it may be also used as
6 just a temporary file if you don't replace the old file contents.
8 Usually, when a program replaces the contents of some file it first opens it for
9 writing, thus losing all of the old data and then starts recreating it. This
10 approach is not very safe because during the regeneration of the file bad things
11 may happen: the program may find that there is an internal error preventing it
12 from completing file generation, the user may interrupt it (especially if file
13 generation takes long time) and, finally, any other external interrupts (power
14 supply failure or a disk error) will leave you without either the original file
17 wxTempFile addresses this problem by creating a temporary file which is meant to
18 replace the original file - but only after it is fully written. So, if the user
19 interrupts the program during the file generation, the old file won't be lost.
20 Also, if the program discovers itself that it doesn't want to replace the old
21 file there is no problem - in fact, wxTempFile will
{\bf not
} replace the old
22 file by default, you should explicitly call
\helpref{Commit
}{wxtempfilecommit
}
23 to do it. Calling
\helpref{Discard
}{wxtempfilediscard
} explicitly discards any
24 modifications: it closes and deletes the temporary file and leaves the original
25 file unchanged. If you don't call neither of Commit() and Discard(), the
26 destructor will call Discard() automatically.
28 To summarize: if you want to replace another file, create an instance of
29 wxTempFile passing the name of the file to be replaced to the constructor (you
30 may also use default constructor and pass the file name to
31 \helpref{Open
}{wxtempfileopen
}). Then you can
\helpref{write
}{wxtempfilewrite
}
32 to wxTempFile using
\helpref{wxFile
}{wxfile
}-like functions and later call
33 Commit() to replace the old file (and close this one) or call Discard() to cancel
36 \wxheading{Derived from
}
40 \wxheading{Include files
}
46 \helpref{wxFile
}{wxfile
}
48 \latexignore{\rtfignore{\wxheading{Members
}}}
50 \membersection{wxTempFile::wxTempFile
}\label{wxtempfilewxtempfilector
}
52 \func{}{wxTempFile
}{\void}
54 Default constructor -
\helpref{Open
}{wxtempfileopen
} must be used to open the
57 \membersection{wxTempFile::wxTempFile
}\label{wxtempfilewxtempfile
}
59 \func{}{wxTempFile
}{\param{const wxString\&
}{strName
}}
61 Associates wxTempFile with the file to be replaced and opens it. You should use
62 \helpref{IsOpened
}{wxtempfileisopened
} to verify if the constructor succeeded.
64 \membersection{wxTempFile::Open
}\label{wxtempfileopen
}
66 \func{bool
}{Open
}{\param{const wxString\&
}{strName
}}
68 Open the temporary file (strName is the name of file to be replaced), returns
69 TRUE on success, FALSE if an error occurred.
71 \membersection{wxTempFile::IsOpened
}\label{wxtempfileisopened
}
72 \constfunc{bool
}{IsOpened
}{\void}
74 Returns TRUE if the file was successfully opened.
76 \membersection{wxTempFile::Write
}\label{wxtempfilewrite
}
78 \func{bool
}{Write
}{\param{const void
}{*p
},
\param{size
\_t }{n
}}
80 Write to the file, return TRUE on success, FALSE on failure.
82 \membersection{wxTempFile::Write
}\label{wxtempfilewrites
}
84 \func{bool
}{Write
}{\param{const wxString\&
}{str
},
\param{wxMBConv&
}{ conv = wxConvLibc
}}
86 Write to the file, return TRUE on success, FALSE on failure.
88 The second argument specifies is only meaningful in Unicode build of wxWindows when
89 {\it conv
} is used to convert
{\it str
} to multibyte representation.
91 \membersection{wxTempFile::Commit
}\label{wxtempfilecommit
}
93 \func{bool
}{Commit
}{\void}
95 Validate changes: deletes the old file of name m
\_strName and renames the new
96 file to the old name. Returns TRUE if both actions succeeded. If FALSE is
97 returned it may unfortunately mean two quite different things: either that
98 either the old file couldn't be deleted or that the new file couldn't be renamed
101 \membersection{wxTempFile::Discard
}\label{wxtempfilediscard
}
103 \func{void
}{Discard
}{\void}
105 Discard changes: the old file contents is not changed, temporary file is
108 \membersection{wxTempFile::
\destruct{wxTempFile
}}\label{wxtempfiledtor
}
110 \func{}{\destruct{wxTempFile
}}{\void}
112 Destructor calls
\helpref{Discard()
}{wxtempfilediscard
} if temporary file