Commited FRM's stockitem patch (empty stock items).

[wxWidgets.git] / docs / latex / wx / snglinst.tex

diff --git a/docs/latex/wx/snglinst.tex b/docs/latex/wx/snglinst.tex
index cab6ba0d4e2020dcc69382846e49f7ec2ed605fa..296a9314ee3adc68be89937c0317e627cee4e6b5 100644 (file)
--- a/docs/latex/wx/snglinst.tex
+++ b/docs/latex/wx/snglinst.tex
@@ -15,7 +15,7 @@ wxSingleInstanceChecker class allows to check that only a single instance of a
 program is running. To do it, you should create an object of this class. As
 long as this object is alive, calls to 
 \helpref{IsAnotherRunning()}{wxsingleinstancecheckerisanotherrunning} from
 program is running. To do it, you should create an object of this class. As
 long as this object is alive, calls to 
 \helpref{IsAnotherRunning()}{wxsingleinstancecheckerisanotherrunning} from

-other processes will return {\tt TRUE}.
+other processes will return {\tt true}.

 
 As the object should have the life span as big as possible, it makes sense to
 create it either as a global or in \helpref{wxApp::OnInit}{wxapponinit}. For
 
 As the object should have the life span as big as possible, it makes sense to
 create it either as a global or in \helpref{wxApp::OnInit}{wxapponinit}. For


@@ -30,12 +30,12 @@ bool MyApp::OnInit()
     {
         wxLogError(_("Another program instance is already running, aborting."));
 
     {
         wxLogError(_("Another program instance is already running, aborting."));
 

-        return FALSE;
+        return false;

     }
 
     ... more initializations ...
 
     }
 
     ... more initializations ...
 

-    return TRUE;
+    return true;

 }
 
 int MyApp::OnExit()
 }
 
 int MyApp::OnExit()


@@ -99,17 +99,26 @@ create the lock file in under Unix (default is
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns {\tt FALSE} if initialization failed, it doesn't mean that another
+Returns {\tt false} if initialization failed, it doesn't mean that another

 instance is running - use 
 \helpref{IsAnotherRunning()}{wxsingleinstancecheckerisanotherrunning} to check
 for it.
 
 instance is running - use 
 \helpref{IsAnotherRunning()}{wxsingleinstancecheckerisanotherrunning} to check
 for it.
 

+\wxheading{Note}
+
+One of possible reasons while Create may fail on Unix is that the lock file
+used for checking already exists but was not created by the user.
+Therefore applications shouldn't treat failure of this function as fatal
+condition, because doing so would open them to the possibility of a Denial of
+Service attack. Instead, they should alert the user about the problem and
+offer to continue execution without checking if another instance is running.
+

 \membersection{wxSingleInstanceChecker::IsAnotherRunning}\label{wxsingleinstancecheckerisanotherrunning}
 
 \constfunc{bool}{IsAnotherRunning}{\void}
 
 \membersection{wxSingleInstanceChecker::IsAnotherRunning}\label{wxsingleinstancecheckerisanotherrunning}
 
 \constfunc{bool}{IsAnotherRunning}{\void}
 

-Returns {\tt TRUE} if another copy of this program is already running, {\tt
-FALSE} otherwise.
+Returns {\tt true} if another copy of this program is already running, {\tt
+false} otherwise.

 
 \membersection{wxSingleInstanceChecker::\destruct{wxSingleInstanceChecker}}\label{wxsingleinstancecheckerdtor}
 
 
 \membersection{wxSingleInstanceChecker::\destruct{wxSingleInstanceChecker}}\label{wxsingleinstancecheckerdtor}