CreateProcess

Module for creating and modifying CreateProcess<'TRes> instances. You can manage:

  • The command (ie file to execute and arguments)
  • The working directory
  • The process environment
  • Stream redirection and pipes
  • Timeout for the process to exit
  • The result and the result transformations (map, mapResult)

More extensions can be found in the CreateProcess Extensions

Example

1: 
2: 
3: 
4: 
Command.RawCommand("file", Arguments.OfArgs ["arg1"; "arg2"])
|> CreateProcess.fromCommand
|> Proc.run
|> ignore
val ignore : value:'T -> unit

Functions and values

Function or valueDescription
addOnExited f c
Signature: f:('?9242 -> int -> '?9243) -> c:CreateProcess<'?9242> -> CreateProcess<'?9243>
Type parameters: '?9242, '?9243

Execute the given function after the process has been exited and the previous result has been calculated.

addOnFinally f c
Signature: f:(unit -> unit) -> c:CreateProcess<'?9212> -> CreateProcess<'?9212>
Type parameters: '?9212

Execute the given function when the process is cleaned up.

addOnSetup f c
Signature: f:(unit -> '?9209) -> c:CreateProcess<'?9210> -> CreateProcess<'?9210>
Type parameters: '?9209, '?9210

Execute the given function before the process is started

addOnStarted f c
Signature: f:(unit -> unit) -> c:CreateProcess<'?9214> -> CreateProcess<'?9214>
Type parameters: '?9214

Execute the given function right after the process is started.

appendSimpleFuncs(...)
Signature: prepareState:(unit -> '?9205) -> onStart:('?9205 -> Process -> unit) -> onResult:(Async<'?9206> -> '?9205 -> Task<RawProcessResult> -> Async<'?9207>) -> onDispose:('?9205 -> unit) -> c:CreateProcess<'?9206> -> CreateProcess<'?9207>
Type parameters: '?9205, '?9206, '?9207

Attaches the given functions to the current CreateProcess instance.

copyRedirectedProcessOutputsToStandardOutputs(...)
Signature: c:CreateProcess<'?9156> -> CreateProcess<'?9156>
Type parameters: '?9156

Copies std-out and std-err into the corresponding System.Console streams (by using interceptStream).

disableTraceCommand(c)
Signature: c:CreateProcess<'?9160> -> CreateProcess<'?9160>
Type parameters: '?9160

Disable the default trace of started processes.

ensureExitCode(r)
Signature: r:CreateProcess<'?9248> -> CreateProcess<'?9248>
Type parameters: '?9248

Makes sure the exit code is 0, otherwise a detailed exception is thrown (showing the command line).

ensureExitCodeWithMessage msg r
Signature: msg:string -> r:CreateProcess<'?9245> -> CreateProcess<'?9245>
Type parameters: '?9245

throws an exception with the given message if exitCode <> 0

fromCommand(command)
Signature: command:Command -> CreateProcess<ProcessResult<unit>>

Create a simple CreateProcess<_> instance from the given command.

Example

1: 
2: 
3: 
4: 
Command.RawCommand("file", Arguments.OfArgs ["arg1"; "arg2"])
|> CreateProcess.fromCommand
|> Proc.run
|> ignore
val ignore : value:'T -> unit
fromRawCommand command args
Signature: command:FilePath -> args:seq<string> -> CreateProcess<ProcessResult<unit>>

Create a CreateProcess from the given file and arguments

Example

1: 
2: 
3: 
CreateProcess.fromRawCommand "cmd" [ "/C";  "echo test" ]
|> Proc.run
|> ignore
val ignore : value:'T -> unit
fromRawCommandLine(...)
Signature: command:FilePath -> windowsCommandLine:string -> CreateProcess<ProcessResult<unit>>

Create a CreateProcess from the given file and arguments

Example

1: 
2: 
3: 
CreateProcess.fromRawCommandLine "cmd" "/C \"echo test\""
|> Proc.run
|> ignore

Using BlackFox.CommandLine

See BlackFox.CommandLine for details

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 
11: 
open BlackFox.CommandLine

CmdLine.empty
|> CmdLine.append "build"
|> CmdLine.appendIf noRestore "--no-restore"
|> CmdLine.appendPrefixIfSome "--framework" framework
|> CmdLine.appendPrefixf "--configuration" "%A" configuration
|> CmdLine.toString
|> CreateProcess.fromRawCommandLine "dotnet.exe"
|> Proc.run
|> ignore
val ignore : value:'T -> unit
fromRawWindowsCommandLine(...)
Signature: command:FilePath -> windowsCommandLine:string -> CreateProcess<ProcessResult<unit>>
Attributes:
[<Obsolete("Use fromRawCommandLine instead.")>]
OBSOLETE

Use fromRawCommandLine instead.

Create a CreateProcess from the given file and arguments

getEnvironmentMap(c)
Signature: c:CreateProcess<'?9220> -> EnvMap
Type parameters: '?9220

Retrieve the current environment map.

interceptStream target s
Signature: target:Stream -> s:StreamSpecification -> StreamSpecification

intercept the given StreamSpecification and writes the intercepted data into target. Throws if the stream is not redirected (ie is Inherit).

map f c
Signature: f:('?9230 -> '?9231) -> c:CreateProcess<'?9230> -> CreateProcess<'?9231>
Type parameters: '?9230, '?9231

Map the current result to a new type.

mapFilePath f c
Signature: f:(FilePath -> FilePath) -> c:CreateProcess<'?9166> -> CreateProcess<'?9166>
Type parameters: '?9166

Map the file-path according to the given function.

mapResult f c
Signature: f:('a -> 'b) -> c:CreateProcess<ProcessResult<'a>> -> CreateProcess<ProcessResult<'b>>
Type parameters: 'a, 'b

Map only the result object and leave the exit code in the result type.

ofStartInfo(p)
Signature: p:ProcessStartInfo -> CreateProcess<ProcessResult<unit>>

Create a CreateProcess from the given ProcessStartInfo

redirectOutput(c)
Signature: c:CreateProcess<'a> -> CreateProcess<ProcessResult<ProcessOutput>>
Type parameters: 'a

Starts redirecting the output streams and collects all data at the end.

replaceFilePath newFilePath c
Signature: newFilePath:FilePath -> c:CreateProcess<'?9164> -> CreateProcess<'?9164>
Type parameters: '?9164

Replace the file-path

setEnvironmentVariable envKey envVar c
Signature: envKey:string -> envVar:string -> c:CreateProcess<'?9222> -> CreateProcess<'?9222>
Type parameters: '?9222

Set the given environment variable.

warnOnExitCode msg r
Signature: msg:string -> r:CreateProcess<unit> -> CreateProcess<unit>

LikeensureExitCode but only triggers a warning instead of failing.

withCommand command c
Signature: command:Command -> c:CreateProcess<'?9162> -> CreateProcess<'?9162>
Type parameters: '?9162

Set the command to the given one.

withEnvironment env c
Signature: env:(string * string) list -> c:CreateProcess<'?9216> -> CreateProcess<'?9216>
Type parameters: '?9216

Sets the given environment variables

withEnvironmentMap env c
Signature: env:EnvMap -> c:CreateProcess<'?9218> -> CreateProcess<'?9218>
Type parameters: '?9218

Sets the given environment map.

withOutputEvents onStdOut onStdErr c
Signature: onStdOut:(string -> unit) -> onStdErr:(string -> unit) -> c:CreateProcess<'a> -> CreateProcess<'a>
Type parameters: 'a

Calls the given functions whenever a new output-line is received.

withOutputEventsNotNull(...)
Signature: onStdOut:(string -> unit) -> onStdErr:(string -> unit) -> c:CreateProcess<'?9240> -> CreateProcess<'?9240>
Type parameters: '?9240

Like withOutputEvents but skips null objects.

withStandardError stdErr c
Signature: stdErr:StreamSpecification -> c:CreateProcess<'?9226> -> CreateProcess<'?9226>
Type parameters: '?9226

Set the standard error stream.

withStandardInput stdIn c
Signature: stdIn:StreamSpecification -> c:CreateProcess<'?9228> -> CreateProcess<'?9228>
Type parameters: '?9228

Set the standard input stream.

withStandardOutput stdOut c
Signature: stdOut:StreamSpecification -> c:CreateProcess<'?9224> -> CreateProcess<'?9224>
Type parameters: '?9224

Set the standard output stream.

withTimeout timeout c
Signature: timeout:TimeSpan -> c:CreateProcess<'a> -> CreateProcess<'a>
Type parameters: 'a

Set the given timeout

withWorkingDirectory workDir c
Signature: workDir:string -> c:CreateProcess<'?9158> -> CreateProcess<'?9158>
Type parameters: '?9158

Set the working directory of the new process.