Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 10.0   10.1   10.2   10.3   10.4   10.5   11.0   11.1   11.2   11.3    Statistic    FMM    Blog  

Component: Shell

Functions to run command line tools.

Run tools in background, send input text and receive output.

Version macOS Windows Linux Server iOS SDK
7.5 / 10.5 ✅ Yes ✅ 98% ✅ 98% ✅ 80% ❌ No

Item Details Server
Shell.AddArgument
Adds an argument.
Mac/Win/Linux
7.5
  ✅ Server
Shell.AddEnvironment
Adds an entry for environment variables.
Mac/Win/Linux
7.5
  ✅ Server
Shell.AvailableBytesError
Queries number of available bytes in error.
Mac/Win/Linux
7.5
  ✅ Server
Shell.AvailableBytesOutput
Queries number of available bytes in output.
Mac/Win/Linux
7.5
  ✅ Server
Shell.ClearArguments
Clears arguments list.
Mac/Win/Linux
7.5
  ✅ Server
Shell.ClearEnvironment
Clears list of environment variables.
Mac/Win/Linux
7.5
  ✅ Server
Shell.CloseInput
Closes input stream.
Mac/Win/Linux
8.3
  ✅ Server
Shell.CloseStreams
Closes all streams.
Mac/Win/Linux
8.3
  ✅ Server
Shell.Execute
Executes a child process.
Mac/Win/Linux
7.5
  ✅ Server
Shell.ExitCode
Queries exit code of child application.
Mac/Win/Linux
7.5
  ✅ Server
Shell.GetApplicationName
Queries application name.
Mac/Win/Linux
7.5
  ✅ Server
Shell.GetArgument
Queries argument.
Mac/Win/Linux
7.5
  ✅ Server
Shell.GetArgumentCount
Queries number of arguments.
Mac/Win/Linux
7.5
  ✅ Server
Shell.GetArguments
Queries arguments as list.
Mac/Win/Linux
9.3
  ✅ Server
Shell.GetBufferSize
Queries desired shell buffer size.
Mac/Win/Linux
10.3
  ✅ Server
Shell.GetCompletedEvaluate
Queries expression to be run when shell is done.
Mac/Win/Linux
7.5
  ❌ Server
Shell.GetCompletedScriptFileName
Queries filename of script to call in when shell is done.
Mac/Win/Linux
7.5
  ❌ Server
Shell.GetCompletedScriptName
Queries name of script to call when shell is done.
Mac/Win/Linux
7.5
  ❌ Server
Shell.GetCurrentDirectory
Queries current directory path.
Mac/Win/Linux
7.5
  ✅ Server
Shell.GetDataAvailableEvaluate
Queries expression to be run when data is available.
Mac/Win/Linux
10.0
  ❌ Server
Shell.GetDataAvailableScriptFileName
Queries filename of script to call in when shell has data available.
Mac/Win/Linux
10.0
  ❌ Server
Shell.GetDataAvailableScriptName
Queries script name to call in when shell has data available.
Mac/Win/Linux
10.0
  ❌ Server
Shell.GetDomain
Queries domain name for login.
Mac/Win/Linux
7.5
  ✅ Server
Shell.GetEnvironment
Queries list with environment variables.
Mac/Win/Linux
7.5
  ✅ Server
Shell.GetPassword
Queries password for login.
Mac/Win/Linux
7.5
  ✅ Server
Shell.GetUsername
Queries user name.
Mac/Win/Linux
7.5
  ✅ Server
Shell.IsRunning
Queries whether application is running.
Mac/Win/Linux
7.5
  ✅ Server
Shell.New
Creates a new shell object.
Mac/Win/Linux
7.5
  ✅ Server
Shell.PeekErrorText
Peeks into error output buffer.
Mac/Win/Linux
7.5
  ✅ Server
Shell.PeekOutputText
Peeks into output buffer.
Mac/Win/Linux
7.5
  ✅ Server
Shell.ProcessIdentifier
Queries process identifier of child process.
Mac/Win/Linux
7.5
  ✅ Server
Shell.ReadErrorText
Reads error.
Mac/Win/Linux
7.5
  ✅ Server
Shell.ReadOutputText
Reads output.
Mac/Win/Linux
7.5
  ✅ Server
Shell.Release
Frees the shell object.
Mac/Win/Linux
7.5
  ✅ Server
Shell.ReleaseAll
Frees all Shell objects.
Mac/Win/Linux
10.5
  ✅ Server
Shell.SetApplicationName
Sets the application name.
Mac/Win/Linux
7.5
  ✅ Server
Shell.SetArguments
Sets list of arguments to parameters of this functions.
Mac/Win/Linux
7.5
  ✅ Server
Shell.SetArgumentsList
Sets list of arguments.
Mac/Win/Linux
7.5
  ✅ Server
Shell.SetBufferSize
Sets desired shell buffer size.
Mac/Win/Linux
10.3
  ✅ Server
Shell.SetCompletedEvaluate
Sets expression to be run when shell is done.
Mac/Win/Linux
7.5
  ❌ Server
Shell.SetCompletedScript
Sets which script to call when shell is done.
Mac/Win/Linux
7.5
  ❌ Server
Shell.SetCurrentDirectory
Sets the current directory to use.
Mac/Win/Linux
7.5
  ✅ Server
Shell.SetDataAvailableEvaluate
Sets expression to be run when shell has data available.
Mac/Win/Linux
10.0
  ❌ Server
Shell.SetDataAvailableScript
Not yet documented
Mac/Win/Linux
10.0
  ❌ Server
Shell.SetDomain
Sets the domain to use for login.
Mac/Win/Linux
7.5
  ✅ Server
Shell.SetPassword
Sets the password for login.
Mac/Win/Linux
7.5
  ✅ Server
Shell.SetUsername
Sets the user name.
Mac/Win/Linux
7.5
  ✅ Server
Shell.Terminate
Terminates the child process.
Mac/Win/Linux
7.5
  ✅ Server
Shell.TerminationReason
Returns the reason the task was terminated.
Mac only
7.5
  ✅ Server
Shell.Wait
Waits for child process.
Mac/Win/Linux
7.5
  ✅ Server
Shell.WriteInputText
Writes a text to input stream.
Mac/Win/Linux
7.5
  ✅ Server

51 functions shown.

Release notes

Blog Entries

FileMaker Magazin

Example Databases

Videos

Feedback: Report problem or ask question.




Links
MBS Xojo tutorial videos

Start Chat