Forráskód Böngészése

Minor change to docs and fixed incorrect name of example code

Thomas Preece 9 éve
szülő
commit
f41e1f73e2

+ 3 - 3
freeprocess.mod/doc/ProcessAttach.bmx → freeprocess.mod/doc/AttachProcess.bmx

@@ -5,17 +5,17 @@ SuperStrict
 'By Default processes are attached to the program (they will automatically terminate when your program is closed)
 'By Default processes are attached to the program (they will automatically terminate when your program is closed)
 Local AttachedProcess:TProcess = CreateProcess("notepad.exe")
 Local AttachedProcess:TProcess = CreateProcess("notepad.exe")
 'Detach notepad process
 'Detach notepad process
-ProcessDetach(AttachedProcess)
+DetachProcess(AttachedProcess)
 
 
 'Reattach notepad process
 'Reattach notepad process
-ProcessAttach(AttachedProcess)
+AttachProcess(AttachedProcess)
 
 
 Print("notepad started!")
 Print("notepad started!")
 Delay(1000)
 Delay(1000)
 
 
 'Create new calculator process and detach from program (will not close when you close your program)
 'Create new calculator process and detach from program (will not close when you close your program)
 Local DetachedProcess:TProcess = CreateProcess("calc.exe")
 Local DetachedProcess:TProcess = CreateProcess("calc.exe")
-ProcessDetach(DetachedProcess)
+DetachProcess(DetachedProcess)
 
 
 Print("calculator started!")
 Print("calculator started!")
 Delay(1000)
 Delay(1000)

+ 3 - 3
freeprocess.mod/doc/ProcessDetach.bmx → freeprocess.mod/doc/DetachProcess.bmx

@@ -5,17 +5,17 @@ SuperStrict
 'By Default processes are attached to the program (they will automatically terminate when your program is closed)
 'By Default processes are attached to the program (they will automatically terminate when your program is closed)
 Local AttachedProcess:TProcess = CreateProcess("notepad.exe")
 Local AttachedProcess:TProcess = CreateProcess("notepad.exe")
 'Detach notepad process
 'Detach notepad process
-ProcessDetach(AttachedProcess)
+DetachProcess(AttachedProcess)
 
 
 'Reattach notepad process
 'Reattach notepad process
-ProcessAttach(AttachedProcess)
+AttachProcess(AttachedProcess)
 
 
 Print("notepad started!")
 Print("notepad started!")
 Delay(1000)
 Delay(1000)
 
 
 'Create new calculator process and detach from program (will not close when you close your program)
 'Create new calculator process and detach from program (will not close when you close your program)
 Local DetachedProcess:TProcess = CreateProcess("calc.exe")
 Local DetachedProcess:TProcess = CreateProcess("calc.exe")
-ProcessDetach(DetachedProcess)
+DetachProcess(DetachedProcess)
 
 
 Print("calculator started!")
 Print("calculator started!")
 Delay(1000)
 Delay(1000)

+ 8 - 10
freeprocess.mod/freeprocess.bmx

@@ -1,5 +1,5 @@
 Rem
 Rem
-bbdoc: Process Management
+bbdoc: System/Execute Processes
 End Rem
 End Rem
 Module PUB.FreeProcess
 Module PUB.FreeProcess
 
 
@@ -209,7 +209,7 @@ End Type
 
 
 Rem
 Rem
 bbdoc: Creates a process
 bbdoc: Creates a process
-returns: TProcess value
+returns: TProcess object that is linked to the process you have started
 End Rem
 End Rem
 Function CreateProcess:TProcess(cmd$,flags=0)
 Function CreateProcess:TProcess(cmd$,flags=0)
 	Return TProcess.Create(cmd,flags)
 	Return TProcess.Create(cmd,flags)
@@ -217,33 +217,31 @@ End Function
 
 
 Rem
 Rem
 bbdoc: Checks status of program
 bbdoc: Checks status of program
-returns: 1 - still running, 0 - no longer running
+returns: 1 if program is still running and 0 otherwise.
 End Rem
 End Rem
-Function ProcessStatus(process:TProcess)
+Function ProcessStatus:Int(process:TProcess)
 	Return process.Status()
 	Return process.Status()
 End Function
 End Function
 
 
 Rem
 Rem
 bbdoc: Detaches a process from program
 bbdoc: Detaches a process from program
-returns: 1
 End Rem
 End Rem
-Function ProcessDetach(process:TProcess)
+Function DetachProcess:Int(process:TProcess)
 	Return process.Detach()
 	Return process.Detach()
 End Function
 End Function
 
 
 Rem
 Rem
 bbdoc: Reattaches a process from program
 bbdoc: Reattaches a process from program
-returns: 1
 End Rem
 End Rem
-Function ProcessAttach(process:TProcess)
+Function AttachProcess:Int(process:TProcess)
 	Return process.Attach()
 	Return process.Attach()
 End Function
 End Function
 
 
 Rem
 Rem
 bbdoc: End Process
 bbdoc: End Process
-returns: 1 - successful, 0 - failed
+returns: 1 if termination of program was successful and 0 otherwise.
 End Rem
 End Rem
-Function TerminateProcess(process:TProcess)
+Function TerminateProcess:Int(process:TProcess)
 	Return process.Terminate()
 	Return process.Terminate()
 End Function
 End Function