Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

ProcStartInfo

Record Fields

Record FieldDescription
Arguments
Signature: string

Gets or sets the set of command-line arguments to use when starting the application.

CreateNoWindow
Signature: bool

Gets or sets a value indicating whether to start the process in a new window.

Domain
Signature: string

Gets or sets a value that identifies the domain to use when starting the process. If this value is null, the UserName property must be specified in UPN format.

Environment
Signature: Map<string,string>

Gets the environment variables that apply to this process and its child processes. NOTE: Recommendation is to not use this Field, but instead use the helper function in the Proc module (for example Process.setEnvironmentVariable) NOTE: This field is ignored when UseShellExecute is true.

ErrorDialog
Signature: bool

Gets or sets a value indicating whether an error dialog box is displayed to the user if the process cannot be started.

ErrorDialogParentHandle
Signature: IntPtr

Gets or sets the window handle to use when an error dialog box is shown for a process that cannot be started.

FileName
Signature: string

Gets or sets the application or document to start.

LoadUserProfile
Signature: bool

true if the Windows user profile should be loaded; otherwise, false. The default is false.

Password
Signature: string

Gets or sets the user password in clear text to use when starting the process.

RedirectStandardError
Signature: bool

true if error output should be written to Process.StandardError; otherwise, false. The default is false.

RedirectStandardInput
Signature: bool

true if input should be read from Process.StandardInput; otherwise, false. The default is false.

RedirectStandardOutput
Signature: bool

true if output should be written to Process.StandardOutput; otherwise, false. The default is false.

StandardErrorEncoding
Signature: Encoding

An object that represents the preferred encoding for error output. The default is null.

StandardOutputEncoding
Signature: Encoding

An object that represents the preferred encoding for standard output. The default is null.

UserName
Signature: string

The user name to use when starting the process. If you use the UPN format, user@DNSdomainname, the Domain property must be null.

UseShellExecute
Signature: bool

true if the shell should be used when starting the process; false if the process should be created directly from the executable file. The default is true.

Verb
Signature: string

The action to take with the file that the process opens. The default is an empty string (""), which signifies no action.

WindowStyle
Signature: ProcessWindowStyle

One of the enumeration values that indicates whether the process is started in a window that is maximized, minimized, normal (neither maximized nor minimized), or not visible. The default is Normal.

WorkingDirectory
Signature: string

When UseShellExecute is true, the fully qualified name of the directory that contains the process to be started. When the UseShellExecute property is false, the working directory for the process to be started. The default is an empty string ("").

Instance members

Instance memberDescription
x.AsStartInfo
Signature: ProcessStartInfo
x.WithEnvironment(map)
Signature: map:Map<string,string> -> ProcStartInfo

Sets the current environment variables.

Static members

Static memberDescription
ProcStartInfo.Create()
Signature: unit -> ProcStartInfo
ProcStartInfo.Empty
Signature: ProcStartInfo
Attributes:
[<Obsolete("Please use 'Create()' instead and make sure to properly set Environment via Process-module funtions!")>]
OBSOLETE

Please use 'Create()' instead and make sure to properly set Environment via Process-module funtions!