Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Uncomment and improve wxFileName::CreateTempFileName() documentation.

Browse Source 
Most of CreateTempFileName() documentation was commented out in r57994 for
some reason, uncomment it back and also improve it.

Closes #14545.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@72269 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2012-07-31 16:49:42 +00:00
parent 6d93e28adf
commit 7740f1c7c9
1 changed files with 23 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
interface/wx/filename.h
View File

@@ -421,34 +421,43 @@ public:
*/ */
void ClearExt(); void ClearExt();
//@{
/** /**
Returns a temporary file name starting with the given @e prefix. Returns a temporary file name starting with the given @e prefix.
If the @a prefix is an absolute path, the temporary file is created in this If @a prefix is an absolute path and ends in a separator, the
directory, otherwise it is created in the default system directory for the temporary file is created in this directory; if it is an absolute
temporary files or in the current directory. filepath or there is no separator, the temporary file is created in its
path, with the 'name' segment prepended to the temporary filename;
otherwise it is created in the default system directory for temporary
files or in the current directory.
If the function succeeds, the temporary file is actually created. If the function succeeds, the temporary file is actually created.
If @a fileTemp is not @NULL, this file will be opened using the name of If @a fileTemp is not @NULL, this wxFile will be opened using the name of
the temporary file. When possible, this is done in an atomic way ensuring that the temporary file. Where possible this is done in an atomic way to ensure that
no race condition occurs between the temporary file name generation and opening no race condition occurs between creating the temporary file name and opening
it which could often lead to security compromise on the multiuser systems. it, which might lead to a security compromise on multiuser systems.
If @a fileTemp is @NULL, the file is only created, but not opened. If @a fileTemp is @NULL, the file is created but not opened.
Under Unix, the temporary file will have read and write permissions for the Under Unix, the temporary file will have read and write permissions for the
owner only to minimize the security problems. owner only, to minimize security problems.
@param prefix @param prefix
Prefix to use for the temporary file name construction Location to use for the temporary file name construction. If @a prefix
is a directory it must have a terminal separator
@param fileTemp @param fileTemp
The file to open or @NULL to just get the name The file to open, or @NULL just to get the name
@return The full temporary file name or an empty string on error. @return The full temporary filepath, or an empty string on error.
*/ */
static wxString CreateTempFileName(const wxString& prefix, static wxString CreateTempFileName(const wxString& prefix,
wxFile* fileTemp = NULL); wxFile* fileTemp = NULL);
/**
This is the same as CreateTempFileName(const wxString &prefix, wxFile *fileTemp)
but takes a wxFFile parameter instead of wxFile.
*/
static wxString CreateTempFileName(const wxString& prefix, static wxString CreateTempFileName(const wxString& prefix,
wxFFile* fileTemp = NULL); wxFFile* fileTemp = NULL);
//@}
/** /**
Returns @true if the directory with this name exists. Returns @true if the directory with this name exists.