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: |
|
Functions and values
Function or value | Description | ||||
addOnExited f c
Signature: f:('a -> int -> 'b) -> c:CreateProcess<'a> -> CreateProcess<'b>
Type parameters: 'a, 'b |
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<'a> -> CreateProcess<'a>
Type parameters: 'a |
Execute the given function when the process is cleaned up. |
||||
addOnSetup f c
Signature: f:(unit -> 'a) -> c:CreateProcess<'b> -> CreateProcess<'b>
Type parameters: 'a, 'b |
Execute the given function before the process is started |
||||
addOnStarted f c
Signature: f:(unit -> unit) -> c:CreateProcess<'?18364> -> CreateProcess<'?18364>
Type parameters: '?18364 |
Execute the given function right after the process is started. |
||||
appendSimpleFuncs(...)
Signature: prepareState:(unit -> '?18355) -> onStart:('?18355 -> Process -> unit) -> onResult:(Async<'?18356> -> '?18355 -> Task<RawProcessResult> -> Async<'?18357>) -> onDispose:('?18355 -> unit) -> c:CreateProcess<'?18356> -> CreateProcess<'?18357>
Type parameters: '?18355, '?18356, '?18357 |
Attaches the given functions to the current CreateProcess instance. |
||||
copyRedirectedProcessOutputsToStandardOutputs(...)
Signature: c:CreateProcess<'?18306> -> CreateProcess<'?18306>
Type parameters: '?18306 |
Copies std-out and std-err into the corresponding |
||||
disableTraceCommand(c)
Signature: c:CreateProcess<'a> -> CreateProcess<'a>
Type parameters: 'a |
Disable the default trace of started processes. |
||||
ensureExitCode(r)
Signature: r:CreateProcess<'?18398> -> CreateProcess<'?18398>
Type parameters: '?18398 |
Makes sure the exit code is |
||||
ensureExitCodeWithMessage msg r
Signature: msg:string -> r:CreateProcess<'?18395> -> CreateProcess<'?18395>
Type parameters: '?18395 |
throws an exception with the given message if |
||||
fromCommand(command)
Signature: command:Command -> CreateProcess<ProcessResult<unit>>
|
Create a simple Example
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
val ignore : value:'T -> unit
|
||||
fromRawCommandLine(...)
Signature: command:FilePath -> windowsCommandLine:string -> CreateProcess<ProcessResult<unit>>
|
Create a CreateProcess from the given file and arguments Example
Using BlackFox.CommandLineSee
val ignore : value:'T -> unit
|
||||
fromRawWindowsCommandLine(...)
Signature: command:FilePath -> windowsCommandLine:string -> CreateProcess<ProcessResult<unit>>
Attributes: [<Obsolete("Use fromRawCommandLine instead.")>] |
OBSOLETEUse fromRawCommandLine instead. Create a CreateProcess from the given file and arguments |
||||
getEnvironmentMap(c)
Signature: c:CreateProcess<'?18370> -> EnvMap
Type parameters: '?18370 |
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:('?18380 -> '?18381) -> c:CreateProcess<'?18380> -> CreateProcess<'?18381>
Type parameters: '?18380, '?18381 |
Map the current result to a new type. |
||||
mapFilePath f c
Signature: f:(FilePath -> FilePath) -> c:CreateProcess<'?18316> -> CreateProcess<'?18316>
Type parameters: '?18316 |
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 |
||||
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<'?18314> -> CreateProcess<'?18314>
Type parameters: '?18314 |
Replace the file-path |
||||
setEnvironmentVariable envKey envVar c
Signature: envKey:string -> envVar:string -> c:CreateProcess<'?18372> -> CreateProcess<'?18372>
Type parameters: '?18372 |
Set the given environment variable. |
||||
warnOnExitCode msg r
Signature: msg:string -> r:CreateProcess<unit> -> CreateProcess<unit>
|
Like |
||||
withCommand command c
Signature: command:Command -> c:CreateProcess<'?18312> -> CreateProcess<'?18312>
Type parameters: '?18312 |
Set the command to the given one. |
||||
withEnvironment env c
Signature: env:(string * string) list -> c:CreateProcess<'?18366> -> CreateProcess<'?18366>
Type parameters: '?18366 |
Sets the given environment variables |
||||
withEnvironmentMap env c
Signature: env:EnvMap -> c:CreateProcess<'?18368> -> CreateProcess<'?18368>
Type parameters: '?18368 |
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<'?18390> -> CreateProcess<'?18390>
Type parameters: '?18390 |
Like |
||||
withStandardError stdErr c
Signature: stdErr:StreamSpecification -> c:CreateProcess<'?18376> -> CreateProcess<'?18376>
Type parameters: '?18376 |
Set the standard error stream. |
||||
withStandardInput stdIn c
Signature: stdIn:StreamSpecification -> c:CreateProcess<'?18378> -> CreateProcess<'?18378>
Type parameters: '?18378 |
Set the standard input stream. |
||||
withStandardOutput stdOut c
Signature: stdOut:StreamSpecification -> c:CreateProcess<'?18374> -> CreateProcess<'?18374>
Type parameters: '?18374 |
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<'a> -> CreateProcess<'a>
Type parameters: 'a |
Set the working directory of the new process. |