【C#】C#から呼び出されたバッチファイルの実行結果を受け取るには

この記事では、C#から呼び出されたバッチファイルの実行結果を受け取る方法についてご説明します。

【動画】C#から呼び出されたバッチファイルの実行結果を受け取る実際の動き

本題に入る前に、まずは次の動画をご覧ください。


まずはC#からバッチファイルが呼び出されてバッチファイルが実行されます。

バッチファイルが実行されると、その実行結果をC#側が受け取りテキストボックスに出力しています。

コードの流れ

STEP.1
バッチファイルを元にProcessStartInfoインスタンスを作成する
バッチファイルを元にProcessStartInfoインスタンスを作成します。
STEP.2
バッチファイルを実行する
バッチファイルを実行します。
STEP.3
バッチファイルで実行されたコマンドの実行結果を取得する
バッチファイルで実行されたコマンドの実行結果を取得します。
取得した実行結果は、今回テキストボックスに出力しています。

バッチファイルとフォームの例

バッチファイル

今回は下のバッチファイルを用意しました。

@echo off
rem pingの実行
ping 192.168.11.0

バッチファイルには、pingコマンドを実行するコードが記述されています。

バッチファイルを実行すると以下の結果が表示されます。(指定したIPアドレスが応答していない状態であることを知らせるメッセージが返ってきた)

フォーム

今回は下のフォームを用意しました。

実行ボタンをクリックするとバッチファイルが実行されて、設置されたテキストボックスにpingコマンドの実行結果が出力されます。

先ほどのバッチファイルの実行結果と同じ内容がテキストボックスに出力されています。

C#のコード(例)

App.configのコード

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <startup> 
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.7.2" />
    </startup>
    <appSettings> 
        <!-- SQL Serverのデータベース名 -->
        <add key="batFilePath" value="C:\work\10_勉強\21_C#\0053\0053.bat" />

    </appSettings>
</configuration>

注目すべきコード

見て頂きたいのは8行目です。

8行目は、バッチファイルのフルパスを「batFilePath」というキーに設定しているコードです。

「batFilePath」のキーの値をフォーム側のコードが参照して使います。

ちなみに、今回呼び出すバッチファイル「C:\work\10_勉強\21_C#\0053\0053.bat」は下の画像にあるバッチファイルです。

フォームのコード

using System;
using System.Windows.Forms;
using System.Configuration;
using System.Diagnostics;

namespace wfcs_0053
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void button1_Click(object sender, EventArgs e)
        {
            // App.configのappSettingsタグ内に記述した「batFilePath」のキーの値を取得して変数「batFilePath」に格納する
            string batFilePath = ConfigurationManager.AppSettings["batFilePath"];

            // バッチファイルを元にProcessStartInfoインスタンスを生成する
            ProcessStartInfo processInfo = new ProcessStartInfo(batFilePath)
            {
                // バッチファイルのウィンドウを表示しないように設定する
                CreateNoWindow = true,

                // バッチファイルの出力結果を標準出力にリダイレクトするように設定する
                RedirectStandardOutput = true,

                // シェル機能を使用せずにプロセスを起動する
                UseShellExecute = false
            };

            // ProcessStartInfoインスタンスを使用してバッチファイルを実行する
            Process process = Process.Start(processInfo);

            // バッチファイルの実行結果を変数outputに格納する
            string output = process.StandardOutput.ReadToEnd();

            // C#側の処理を待機する
            process.WaitForExit();

            // テキストボックスに出力する
            textBox1.Text = output;
        }
    }
}

注目すべきコード①

最初に見て頂きたいのは18行目です。

            // App.configのappSettingsタグ内に記述した「batFilePath」のキーの値を取得して変数「batFilePath」に格納する
            string batFilePath = ConfigurationManager.AppSettings["batFilePath"];

コードの説明

以上のコードは、App.configのappSettingsタグ内に記述した「batFilePath」のキーの値を取得して変数に格納するコードです。

「batFilePath」のキーの値は変数「batFilePath」に格納します。

注目すべきコード②

次に見て頂きたいのは21行目から31行目です。

            // バッチファイルを元にProcessStartInfoインスタンスを生成する
            ProcessStartInfo processInfo = new ProcessStartInfo(batFilePath)
            {
                // バッチファイルのウィンドウを表示しないように設定する
                CreateNoWindow = true,

                // バッチファイルの出力結果を標準出力にリダイレクトするように設定する
                RedirectStandardOutput = true,

                // シェル機能を使用せずにプロセスを起動する
                UseShellExecute = false
            };

コードの説明

以上のコードは、バッチファイルを元にProcessStartInfoインスタンスを生成して、バッチファイルを実行する際の各情報を設定します。

コードの詳細

21行目のコードは、バッチファイルを元にProcessStartInfoインスタンスを生成します。

このインスタンスを生成することで、バッチファイルを実行したり、実行するバッチファイルの設定を色々と行うことができます。

24行目のコードでは、CreateNoWindowプロパティにtrueを設定しています。

CreateNoWindowプロパティにtrueを設定することで、バッチファイルのウィンドウが表示されなくなります。

27行目のコードでは、RedirectStandardOutputプロパティにtrueを設定しています。

RedirectStandardOutputプロパティにtrueを設定することで、バッチファイルの実行結果を直接読み取ることができるようになります。

30行目のコードでは、UseShellExecuteプロパティにfalseしています。

UseShellExecuteプロパティにfalseを設定することで、シェル経由で実行されず、バッチファイルの起動が直接実行されて高速化されます。(パフォーマンスの向上)

注目すべきコード③

次に見て頂きたいのは34行目から43行目です。

            // ProcessStartInfoインスタンスを使用してバッチファイルを実行する
            Process process = Process.Start(processInfo);

            // バッチファイルの実行結果を変数outputに格納する
            string output = process.StandardOutput.ReadToEnd();

            // C#側の処理を待機する
            process.WaitForExit();

            // テキストボックスに出力する
            textBox1.Text = output;

コードの説明

以上のコードは、ProcessStartInfoインスタンスを使用してバッチファイルを実行し、実行結果をテキストボックスに格納する処理のコードです。

コードの詳細

34行目のコードでは、ProcessStartInfoインスタンスを使用してバッチファイルを実行します。

37行目のコードでは、バッチファイルの実行結果を変数outputに格納します。

40行目のコードでは、バッチファイルの処理よりもC#側の処理が先に終わらないよう、C#側の処理を待機します。

43行目のコードでは、バッチファイルの実行結果が格納された変数outputの値をテキストボックスに出力します。

動作確認

バッチファイルとフォームの例」をご覧ください。

最後に

この記事では、C#から呼び出されたバッチファイルの実行結果を受け取る方法についてご説明しました。

C#から呼び出されたバッチファイルの実行結果を受け取りたい場合は本記事を参考にして頂けたら幸いです。

プログラミングのスキルを習得するなら

プログラミングのスキルを習得したい、今のスキルをもっと高めたい、そう考えているなら「プログラミングスクール」がおすすめです。

プログラミングのスキルの基礎を身につけるなら「TechAcademy」で1週間の無料体験があるので、これで「プログラミングの基礎」を学ぶのにおすすめですよ。

→ TechAcademyの「1週間 無料体験」はこちら