X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f7d886af3a5e8805a7b073e40ff80fd21ea273e7..bd330a69c9555c29c6fc448a61e58e0d49402c47:/docs/latex/wx/filename.tex?ds=sidebyside diff --git a/docs/latex/wx/filename.tex b/docs/latex/wx/filename.tex index a713b4d068..36936b7d1c 100644 --- a/docs/latex/wx/filename.tex +++ b/docs/latex/wx/filename.tex @@ -226,7 +226,7 @@ Set this file name object to the home directory. \membersection{wxFileName::AssignTempFileName}\label{wxfilenameassigntempfilename} -\func{void}{AssignTempFileName}{\param{const wxString\& }{prefix}} +\func{void}{AssignTempFileName}{\param{const wxString\& }{prefix}, \param{wxFile *}{fileTemp = {\tt NULL}}} The function calls \helpref{CreateTempFileName}{wxfilenamecreatetempfilename} to create a temporary file and sets this object to the name of the file. If a @@ -241,16 +241,28 @@ Reset all components to default, uninitialized state. \membersection{wxFileName::CreateTempFileName}\label{wxfilenamecreatetempfilename} -\func{static wxString}{CreateTempFileName}{\param{const wxString\& }{prefix}} +\func{static wxString}{CreateTempFileName}{\param{const wxString\& }{prefix}, \param{wxFile *}{fileTemp = {\tt NULL}}} Returns a temporary file name starting with the given {\it prefix}. If the {\it prefix} is an absolute path, the temporary file is created in this directory, otherwise it is created in the default system directory for the temporary files or in the current directory. -If the function succeeds, the temporary file is actually created (but not -opened) as well. Under Unix, it will have read and write permissions for the -owner only. +If the function succeeds, the temporary file is actually created. If\rtfsp +{\it fileTemp} is not {\tt NULL}, this file will be opened using the name of +the temporary file. When possible, this is done in an atomic way ensuring that +no race condition occurs between the temporary file name generation and opening +it which could often lead to security compromise on the multiuser systems. +If {\it fileTemp} is {\tt NULL}, the file is only created, but not opened. + +Under Unix, the temporary file will have read and write permissions for the +owner only to minimize the security problems. + +\wxheading{Parameters} + +\docparam{prefix}{Prefix to use for the temporary file name construction} + +\docparam{fileTemp}{The file to open or {\tt NULL} to just get the name} \wxheading{Return value}