CS2001～

C# CS8178エラーについて解説：参照渡しとawait利用時の注意点

2025-03-29更新日: 2025-03-29

CS8178は、C#のコンパイル時エラーの一つで、返り値を参照渡しするメソッドの呼び出し式内で非同期処理用のawaitを使用した場合に発生します。

エラーが発生する理由は、参照渡しの戻り値と非同期処理の組み合わせが適切に同期されないためです。

解決するには、非同期処理を行う部分と参照渡しの処理を分離して、同期的に実行するように変更する必要があります。

目次から探す

エラーの背景
- C#における参照渡しの基本
- awaitによる非同期処理の概要
エラー発生の原因
- 参照渡し戻り値の仕組みと制限
- await使用時の同期不整合
エラー発生例の検証
- コード例で確認するエラー再現
解決策の提案
まとめ

エラーの背景

C#における参照渡しの基本

C#では、メソッドの戻り値として変数の参照(リファレンス)を返すことが可能です。

refキーワードを使用することで、呼び出し元と同じメモリ上の値を直接操作できるようになります。

例えば、下記のサンプルコードではSaveメソッドがクラスフィールドxの参照を返しており、呼び出し側で直接その値を変更することができます。

using System;
class TestClass {
    private int x; // クラスフィールド
    // 引数で受け取った値をフィールドxに設定し、その参照を返す
    public ref int Save(int y) {
        x = y;
        return ref x;
    }
    public static void Main() {
        TestClass instance = new TestClass();
        // Saveから返された参照を通じてxの値を出力
        ref int refX = ref instance.Save(10);
        Console.WriteLine("参照渡しによるxの値: " + refX); // 出力結果: 参照渡しによるxの値: 10
    }
}

このようにref戻り値を用いると、メソッドが返す値がコピーではなく、元のデータそのものに対する参照となるため、パフォーマンスの向上や意図した変更が直接反映されるといったメリットがあります。

awaitによる非同期処理の概要

awaitは、非同期メソッド(asyncキーワードが付与されたメソッド)の中で利用され、非同期処理が完了するまで実行を一時停止します。

これにより、メインスレッドをブロックすることなく、バックグラウンドでタスクが実行されるため、UIの応答性が保たれるなどの利点があります。

下記のサンプルコードは、Task.FromResultを使用してすぐに完了するタスクから値を取得し、awaitを用いてその結果が返されるまで待機する例です。

using System;
using System.Threading.Tasks;
class AsyncExample {
    // 非同期メソッド。awaitを使用してタスクの完了を待つ
    public async Task ExecuteAsync() {
        Console.WriteLine("非同期処理開始");
        int result = await Task.FromResult(100); // タスク完了待ち
        Console.WriteLine("非同期処理結果: " + result);
    }
    public static void Main() {
        AsyncExample example = new AsyncExample();
        // 非同期メソッドの完了を待ってプログラムを終了
        example.ExecuteAsync().GetAwaiter().GetResult();
    }
}

このようにawaitは、非同期処理が終わるまでの間、後続の処理を一時停止して効率的なプログラム実行を可能にしています。

エラー発生の原因

参照渡し戻り値の仕組みと制限

C#におけるref戻り値は、メソッド呼び出しの直後に参照として利用される前提となっています。

しかし、この仕組みにはいくつかの制限があり、特に非同期処理との組み合わせには注意が必要です。

非同期メソッド中でawaitを利用すると、処理の一時停止と再開が発生するため、コンパイラは参照渡しの即時性が損なわれることを検知し、エラーを発生させる場合があります。

具体的には、参照渡し戻り値の直後にawaitを用いると、そのタイミングでメソッドの実行が一時中断され、参照先の整合性が保証されなくなるため、C#コンパイラはエラー CS8178 を出力します。

await使用時の同期不整合

awaitは非同期処理の結果を待つために使用されますが、リファレンス型の戻り値の場合、返された参照に対して即座に値を設定する設計が前提となっています。

非同期な待機状態において、参照渡しとして返された変数への代入が遅延することで、同期が保たれなくなります。

そのため、awaitの使用によって発生するタイミングのずれが、参照渡しの即時代入を要求するコードとの整合性を乱し、結果としてCS8178エラーが発生してしまいます。

$CS8178: 参照戻り値の呼び出し式内で”await”は使用できません$

このエラーは、コンパイラが上記のような不整合を検出した場合に出力されるため、非同期処理と参照渡しを組み合わせる際は、処理の流れを再考する必要があります。

エラー発生例の検証

コード例で確認するエラー再現

awaitを用いたケースの詳細

以下のサンプルコードは、ref戻り値を持つSaveメソッドに対して、awaitを直接使用した例です。

この実装では、Saveメソッドの呼び出し直後にawaitが使われるため、CS8178エラーが発生します。

using System;
using System.Threading.Tasks;
class TestClass {
    private int x;
    // 引数を受け取り、フィールドxに代入した後、その参照を返す
    public ref int Save(int y) {
        x = y;
        return ref x;
    }
    // 非同期メソッド内でref戻り値にawaitを直接使用するパターン(エラー発生)
    public async Task TestMethod() {
        // 以下の行はCS8178エラーによりコンパイルエラーとなる
        Save(1) = await Task.FromResult(0);
    }
    public static void Main() {
        TestClass instance = new TestClass();
        // 非同期メソッドの実行と完了待ち
        instance.TestMethod().GetAwaiter().GetResult();
    }
}

// コンパイル時エラー:
// error CS8178: 参照渡しで返すため、'Save' の呼び出しが含まれる式では 'await' を使用することができません

コンパイラのエラーメッセージ解析

上記のエラーから分かるように、コンパイラはSaveの呼び出し式に対してawaitが使用されていることを検出し、参照渡しの要件が満たされない状況としてエラーを報告します。

エラーメッセージは以下のようになっており、参照渡しと非同期処理の組み合わせが問題となっていることを明確に示しています。

「参照渡しで返すため、'{0}’ の呼び出しが含まれる式では ‘await’ を使用することができません」

このメッセージから、非同期処理の途中で参照渡しの戻り値に対して直接awaitを適用することが禁止されている点が理解できます。

解決策の提案

同期処理への切り替え方法

このエラーを解決する一般的な方法は、非同期処理の結果を一旦通常の変数に格納し、その後で参照渡しの戻り値と組み合わせる方法です。

すなわち、awaitの呼び出し結果を変数に代入してから、refメソッドを呼び出すように処理の順序を変更します。

修正前と修正後のコード比較

以下に、修正前のコードと修正後のコードの比較例を示します。

修正前

public async Task TestMethod() {
    // CS8178エラー発生箇所
    Save(1) = await Task.FromResult(0);
}

修正後

public async Task TestMethod() {
    // awaitの結果を変数に格納してから、ref返しのメソッドに代入
    int tempValue = await Task.FromResult(0);
    Save(1) = tempValue;
}

この修正により、非同期処理が正しく完了してから通常の変数をSaveメソッドの返す参照に代入することが可能となり、エラーが解消されます。

修正時の注意事項

修正を行う際には、以下の点に留意してください。

awaitの結果をすぐに変数へ格納して、その変数を使用することで、非同期処理の一時停止によるタイミングのずれを回避する。
元の設計意図が参照渡しを必要としている場合、修正後のロジックが同様の動作を保証しているか確認する。
非同期処理と同期処理の境界でデータの整合性が維持されるよう、コードの実行順序をしっかり把握しておく。

開発環境での検証方法

IDEのエラー検出機能活用

Visual StudioやRiderなどの統合開発環境(IDE)では、コンパイルエラーがリアルタイムに検出されるため、CS8178エラーが発生した場合は、エディタ上にエラー表示が出る点を確認してください。

エラーメッセージには、どのコード部分に問題があるかが示されているため、速やかに該当箇所を特定し修正に取り組むことが可能です。

また、IDEの詳細なエラー説明やリファレンス機能を活用することで、参照渡しと非同期処理の組み合わせに関する理解を深める一助となります。

修正後の動作確認手順

修正後は、以下の手順で動作確認を行ってください。

変更を加えたコードをビルドし、コンパイルエラーが解消されているか確認する。
非同期メソッドを含むプログラム全体の動作確認を行い、意図した結果が出力されることを確かめる。
特に、awaitの結果が正しく変数に格納され、参照渡しによる値の更新が行われるかをテストケースを用いて検証する。

このように、IDEのエラー検出機能と段階的な動作確認を組み合わせることで、修正による副作用を防ぎ、安定したコード実装が実現できます。

まとめ

この記事では、C#における参照渡しの基本と、非同期処理でのawait利用の仕組みを学びました。

参照渡し戻り値が即時性を要求するため、非同期処理との組み合わせで生じる同期不整合がCS8178エラーの原因となること、またサンプルコードを通してエラーの再現と修正策(await結果を一時変数へ格納する方法)を理解できました。