Process.RunAndCaptureTextAsync Метод

Определение

Пространство имен:

System.Diagnostics

Сборки:

netstandard.dll, System.Diagnostics.Process.dll

Перегрузки

Имя.	Описание
RunAndCaptureTextAsync(ProcessStartInfo, CancellationToken)	Асинхронно запускает процесс, описанный в startInfoописании, записывает стандартные выходные данные и ошибку, ожидает выхода и возвращает захваченный текст и состояние выхода.
RunAndCaptureTextAsync(String, IEnumerable<String>, CancellationToken)	Асинхронно запускает процесс с указанным именем файла и необязательными аргументами, записывает стандартные выходные данные и ошибки, ожидает выхода и возвращает захваченный текст и состояние выхода.

RunAndCaptureTextAsync(ProcessStartInfo, CancellationToken)

Исходный код:

Process.Scenarios.cs

Асинхронно запускает процесс, описанный в startInfoописании, записывает стандартные выходные данные и ошибку, ожидает выхода и возвращает захваченный текст и состояние выхода.

[System.Runtime.Versioning.SupportedOSPlatform("maccatalyst")]
[System.Runtime.Versioning.UnsupportedOSPlatform("ios")]
[System.Runtime.Versioning.UnsupportedOSPlatform("tvos")]
public static System.Threading.Tasks.Task<System.Diagnostics.ProcessTextOutput> RunAndCaptureTextAsync(System.Diagnostics.ProcessStartInfo startInfo, System.Threading.CancellationToken cancellationToken = default);

[<System.Runtime.Versioning.SupportedOSPlatform("maccatalyst")>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>]
static member RunAndCaptureTextAsync : System.Diagnostics.ProcessStartInfo * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Diagnostics.ProcessTextOutput>

Public Shared Function RunAndCaptureTextAsync (startInfo As ProcessStartInfo, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ProcessTextOutput)

Параметры

startInfo

ProcessStartInfo

Содержит ProcessStartInfo сведения, используемые для запуска процесса.

cancellationToken

CancellationToken

Маркер для отмены асинхронной операции. Если маркер отменен, процесс будет убит.

Возвращаемое значение

Task<ProcessTextOutput>

Задача, представляющая асинхронную операцию. Значение задачи содержит захваченные текстовые выходные данные и состояние выхода процесса.

Атрибуты

SupportedOSPlatformAttribute UnsupportedOSPlatformAttribute

Исключения

ArgumentNullException

startInfo равно null.

InvalidOperationException

UseShellExecute задан как true.

–или–

RedirectStandardOutput или RedirectStandardError не задано значение true.

OperationCanceledException

При cancellationToken чтении перенаправленных потоков было отменено.

Комментарии

Если при чтении перенаправленных потоков происходит отмена, метод пытается убить процесс и вызывает вызов OperationCanceledException. Если отмена возникает после того, как потоки были полностью прочитаны, но при ожидании завершения процесса процесс будет убит и возвращено ExitStatusCanceled значение true.

RunAndCaptureTextAsync(String, IEnumerable<String>, CancellationToken)

Исходный код:

Process.Scenarios.cs

Асинхронно запускает процесс с указанным именем файла и необязательными аргументами, записывает стандартные выходные данные и ошибки, ожидает выхода и возвращает захваченный текст и состояние выхода.

[System.Runtime.Versioning.SupportedOSPlatform("maccatalyst")]
[System.Runtime.Versioning.UnsupportedOSPlatform("ios")]
[System.Runtime.Versioning.UnsupportedOSPlatform("tvos")]
public static System.Threading.Tasks.Task<System.Diagnostics.ProcessTextOutput> RunAndCaptureTextAsync(string fileName, System.Collections.Generic.IEnumerable<string>? arguments = default, System.Threading.CancellationToken cancellationToken = default);

[<System.Runtime.Versioning.SupportedOSPlatform("maccatalyst")>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>]
[<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>]
static member RunAndCaptureTextAsync : string * seq<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Diagnostics.ProcessTextOutput>

Public Shared Function RunAndCaptureTextAsync (fileName As String, Optional arguments As IEnumerable(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ProcessTextOutput)

Параметры

fileName

String

Имя запускаемого исполняемого файла.

arguments

IEnumerable<String>

Аргументы командной строки для передачи в процесс. Передайте null или пустую последовательность, чтобы запустить процесс без дополнительных аргументов.

cancellationToken

CancellationToken

Маркер для отмены асинхронной операции. Если маркер отменен, процесс будет убит.

Возвращаемое значение

Task<ProcessTextOutput>

Задача, представляющая асинхронную операцию. Значение задачи содержит захваченные текстовые выходные данные и состояние выхода процесса.

Атрибуты

SupportedOSPlatformAttribute UnsupportedOSPlatformAttribute

Исключения

ArgumentNullException

fileName равно null.

ArgumentException

fileName значение пусто.

OperationCanceledException

При cancellationToken чтении перенаправленных потоков было отменено.

Комментарии

Если при чтении перенаправленных потоков происходит отмена, метод пытается убить процесс и вызывает вызов OperationCanceledException. Если отмена возникает после того, как потоки были полностью прочитаны, но при ожидании завершения процесса процесс будет убит и возвращено ExitStatusCanceled значение true.