Platforms to show: All Mac Windows Linux Cross-Platform

Shell

Shell classes to run command line tools.

• Globals
  • ConsoleExecuteMBS(path as folderitem, arguments() as string, environment() as string) as Integer
  • ConsoleExecuteMBS(path as string, arguments() as string, environment() as string) as Integer
• Classes
  • class ShellMBS
    • method Arguments as String()
    • method CloseInput
    • method CloseStreams
    • method Constructor
    • method Destructor
    • method Execute(Executable as String)
    • method ExitCode as Integer
    • method Poll
    • method ReadError as String
    • method ReadOutput as String
    • method SetArguments(arguments() as String)
    • method Terminate(WinExitCode as Integer = 255) as boolean
    • method Wait(TimeOut as double = 30.0)
    • method WriteInput(data as string) as Integer
    • property ApplicationName as String
    • property AvailableBytesError as Integer
    • property AvailableBytesOutput as Integer
    • property CurrentDirectory as String
    • property Domain as String
    • property Environment as Dictionary
    • property ErrorCode as Integer
    • property Executable as String
    • property IsRunning as Boolean
    • property MergeErrorAndOutput as Boolean
    • property Password as String
    • property PID as Integer
    • property ProcessHandle as Integer
    • property Tag as Variant
    • property ThreadHandle as Integer
    • property Username as String
    • event Completed
    • event DataAvailable(AvailableBytesError as Integer, AvailableBytesOutput as Integer)
  • class WindowsProcessMBS
    • method Close
    • method PeekError(Length as Integer = 0) as String
    • method PeekOutput(Length as Integer = 0) as String
    • method Poll
    • 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
    • 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
    • event DataAvailable(AvailableBytesOutput as Integer, AvailableBytesError as Integer)
    • event Terminated(ExitCode as Integer)
• Examples
  • /Util/Shell
  • /Win/Windows Shell
• Blog Entries
  • MBS Xojo Plugins, version 26.3pr6
  • AI Development with the MBS Xojo Plugins
  • News from the MBS Xojo Plugins Version 25.3
  • MBS Xojo Plugins, version 25.3pr1
  • News from the MBS Xojo Plugins Version 25.0
  • News from the MBS Xojo Plugins in Version 23.0
  • MonkeyBread Software Releases the MBS Xojo Plugins in version 21.2
  • MBS Xojo Plugins in version 19.2
  • MonkeyBread Software Releases the MBS Xojo Plugins in version 17.1
  • Running command lines tools on Windows

Release notes

• Version 26.3
  • Fixed an issue with ShellMBS class not finding our shared NSDictionary code.
• Version 25.3
  • Added Poll for the WindowsProcessMBS class.
• Version 25.0
  • Added MergeErrorAndOutput property to ShellMBS class.
• Version 23.5
  • Fixed Terminate in ShellMBS class for Windows to work better.
• Version 23.0
  • Added Tag property to ShellMBS class.
  • Fixed ExitCode for ShellMBS class on Linux.
• Version 21.5
  • Enabled ConsoleExecuteMBS method for desktop projects.
• Version 21.2
  • Fixed ShellMBS and WindowsProcessMBS classes for Windows to allow PowerShell.exe to run.
• Version 20.1
  • Fixed a bug in ShellMBS class when running applications on Windows with empty ApplicationName.
• Version 20.0
  • Fixed ReadError and ReadOutput for WindowsProcessMBS class to return empty string when called with value zero.

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