Monkeybread Xojo plugin - WindowsProcessMBS class

Platforms to show: All Mac Windows Linux Cross-Platform

WindowsProcessMBS class

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
class	Shell	MBS Win Plugin	17.1	❌ No	✅ Yes	❌ No	❌ No	Desktop, Console & Web

Function: The class to run processes on Windows.
Example:

// run command
dim w as new WindowsProcessMBS

w.CommandLine = "cmd /c dir"
w.CurrentDirectory = "C:"

if not w.run then
  MsgBox w.LastErrorMessage
  Return
end if

// wait
while w.Running
  app.YieldToNextThread
wend

// show result
dim a as Integer = w.AvailableBytesOutput
dim r as string = w.ReadOutput(a)
MsgBox r

Notes:
Can be used like shell, but with more windows specific options.
For interactive shell, you need to run cmd.exe yourself.
This shell is asynchronously. For synchrones mode, please write yourself a loop waiting for process to finish.

Please read Microsoft documentation for more details:
https://msdn.microsoft.com/en-us/library/windows/desktop/ms682425(v=vs.85).aspx

See also NSTask (Mac only), WindowsShellExecuteAsAdminMBS, WindowsShellExecuteMBS (Windows only), ConsoleExecuteMBS and ShellMBS (cross platform).

Feedback, Comments & Corrections

2 events
- event DataAvailable(AvailableBytesOutput as Integer, AvailableBytesError as Integer)
- event Terminated(ExitCode as Integer)
17 properties
- property ApplicationName as String
- property AvailableBytesError as Integer
- property AvailableBytesOutput as Integer
- property CommandLine as String
- property CurrentDirectory as String
- property Domain as String
- property Environment as Dictionary
- property ExitCode as Integer
- property LastError as Integer
- property LastErrorMessage as String
- property Password as String
- property ProcessHandle as Integer
- property ProcessID as Integer
- property Running as Boolean
- property ThreadHandle as Integer
- property ThreadID as Integer
- property UserName as String
10 methods
- method Close
- method PeekError(Length as Integer = 0) as String
- method PeekOutput(Length as Integer = 0) as String
- method ReadError(Length as Integer = 0) as String
- method ReadOutput(Length as Integer = 0) as String
- method Run as Boolean
- method SetKillProcessWhenParentDies as boolean
- method Terminate(ExitCode as Integer) as Boolean
- method Write(Data as MemoryBlock) as Integer
- method Write(Data as String) as Integer

This class has no sub classes.

Some examples using this class:

/Win/Windows Shell

Blog Entries

Xojo Developer Magazine

15.3, page 11: News

The items on this page are in the following plugins: MBS Win Plugin.

WindowsPrinterMBS - WindowsProcessMemoryInfoMBS