C# Ref（開発者向けの動作方法）

ref パラメーターを理解する

refパラメータは、メソッドに渡された変数への参照として機能するメソッドパラメータです。 通常の値パラメータとは異なり、変数のコピーが渡されるのではなく、refパラメータは元の変数の値を変更できるようにします。 この動作は、メソッドに渡される変数の状態を更新する必要がある場合に重要です。

次の例を考えてrefの基本的な使用法を示します。具体的には、参照型変数がメソッド呼び出しを通して同じオブジェクト内でパラメータ値を保持する方法に焦点を当てます。

class Program
{
    static void Main()
    {
        int number = 100;
        ModifyNumber(ref number);
        Console.WriteLine(number); // Output: 200
    }

    // Method that modifies the original number through 'ref'
    static void ModifyNumber(ref int number)
    {
        number = 200; // Modifies the original value
    }
}

class Program
{
    static void Main()
    {
        int number = 100;
        ModifyNumber(ref number);
        Console.WriteLine(number); // Output: 200
    }

    // Method that modifies the original number through 'ref'
    static void ModifyNumber(ref int number)
    {
        number = 200; // Modifies the original value
    }
}

Friend Class Program
	Shared Sub Main()
		Dim number As Integer = 100
		ModifyNumber(number)
		Console.WriteLine(number) ' Output: 200
	End Sub

	' Method that modifies the original number through 'ref'
	Private Shared Sub ModifyNumber(ByRef number As Integer)
		number = 200 ' Modifies the original value
	End Sub
End Class

この例では、refパラメータとして渡します。 Mainメソッドの元の値に反映され、コンソールに200が表示されます。

ref パラメーターの動作方法

メソッドパラメータをrefキーワードで宣言する際、コンパイラにそのパラメータがコピーではなく元の変数を参照することを伝えます。 これは、実際の値ではなく、変数のメモリ アドレスを渡すことで実現されます。 呼び出されたメソッドと呼び出しメソッドの両方が同じメモリ ロケーションにアクセスするため、パラメーターに対する変更は元の変数に直接適用されます。

refを理解する鍵は、それが値型と参照型の両方で使用できることを認識することです。値型には整数や構造体のようなシンプルなデータ型が含まれ、参照型にはオブジェクトや配列が含まれます。 参照型変数が本来メモリアドレスを保持しているにもかかわらず、refを参照型と共に使用すると、オブジェクトの内容だけでなく実際の参照を変更できるようになります。

ref と out の違い

outキーワードの両方は元の変数を修正することを許可しますが、重要な相違点があります。 outパラメータは、メソッドに渡される前に初期化する必要はありません。 逆に、refパラメータは、変数をメソッドに渡す前に初期化する必要があります。 さらに、outパラメータを使用するメソッドは、メソッドが戻る前に値を割り当てる義務があります。 この要件はrefパラメータには適用されません。

ここではoutキーワードの使用方法を示します。

class Program
{
    static void Main()
    {
        int result;
        CalculateResult(out result);
        Console.WriteLine(result); // Output: 100
    }

    // Method that calculates a result and assigns it via 'out'
    static void CalculateResult(out int calculation)
    {
        calculation = 20 * 5; // Must initialize the out parameter
    }
}

class Program
{
    static void Main()
    {
        int result;
        CalculateResult(out result);
        Console.WriteLine(result); // Output: 100
    }

    // Method that calculates a result and assigns it via 'out'
    static void CalculateResult(out int calculation)
    {
        calculation = 20 * 5; // Must initialize the out parameter
    }
}

Friend Class Program
	Shared Sub Main()
		Dim result As Integer = Nothing
		CalculateResult(result)
		Console.WriteLine(result) ' Output: 100
	End Sub

	' Method that calculates a result and assigns it via 'out'
	Private Shared Sub CalculateResult(ByRef calculation As Integer)
		calculation = 20 * 5 ' Must initialize the out parameter
	End Sub
End Class

この場合、Mainはその結果を反映します。

メソッド オーバーロードでの ref の実用的な使用

refキーワードによってメソッドシグネチャが変更されます。 メソッドシグネチャは、メソッド名とそのパラメータ型で構成され、参照によってパラメータが渡されるか(ref) 、値として渡されるか、またはoutパラメータとして渡されるかを含みます。

refと値パラメータに基づいてメソッドをオーバーロードすることを考えます。

class Program
{
    static void Main()
    {
        int normalParameter = 10, refParameter = 10;
        IncrementValue(normalParameter);
        IncrementValue(ref refParameter);
        Console.WriteLine($"Normal: {normalParameter}, Ref: {refParameter}"); // Output: Normal: 10, Ref: 11
    }

    // Method that increments a copy of the integer
    static void IncrementValue(int number)
    {
        number++;
    }

    // Method that increments the original integer using 'ref'
    static void IncrementValue(ref int number)
    {
        number++;
    }
}

class Program
{
    static void Main()
    {
        int normalParameter = 10, refParameter = 10;
        IncrementValue(normalParameter);
        IncrementValue(ref refParameter);
        Console.WriteLine($"Normal: {normalParameter}, Ref: {refParameter}"); // Output: Normal: 10, Ref: 11
    }

    // Method that increments a copy of the integer
    static void IncrementValue(int number)
    {
        number++;
    }

    // Method that increments the original integer using 'ref'
    static void IncrementValue(ref int number)
    {
        number++;
    }
}

Friend Class Program
	Shared Sub Main()
		Dim normalParameter As Integer = 10, refParameter As Integer = 10
		IncrementValue(normalParameter)
		IncrementValue(refParameter)
		Console.WriteLine($"Normal: {normalParameter}, Ref: {refParameter}") ' Output: Normal: 10, Ref: 11
	End Sub

	' Method that increments a copy of the integer
'INSTANT VB TODO TASK: VB does not allow method overloads which differ only in parameter ByVal/ByRef:
'ORIGINAL LINE: static void IncrementValue(int number)
	Private Shared Sub IncrementValue(ByVal number As Integer)
		number += 1
	End Sub

	' Method that increments the original integer using 'ref'
'INSTANT VB TODO TASK: VB does not allow method overloads which differ only in parameter ByVal/ByRef:
'ORIGINAL LINE: static void IncrementValue(ref int number)
	Private Shared Sub IncrementValue(ByRef number As Integer)
		number += 1
	End Sub
End Class

ここでは、refパラメータを取るバージョンでオーバーロードされています。 refバージョンは元の変数をインクリメントし、普通のバージョンはコピーのみを変更します。

IronPDFの紹介

IronPDF .NET 向け PDF Solutions は、PDF ドキュメントを操作するために設計された包括的な .NET ライブラリです。 主に C# で構築されており、HTML コンテンツから PDF を作成することを簡素化することに焦点を当てています。 IronPDF は Chrome レンダリング エンジンを採用しており、HTML、CSS、JavaScript、画像コンテンツのニュアンスを捉えた高品質でピクセル パーフェクトな PDF ドキュメントを提供します。

このライブラリは柔軟で、.NET Framework、.NET Core、.NET Standard を含む幅広い .NET 環境をサポートしており、デスクトップから Web ベースのシステムまでさまざまなアプリケーションに適しています。 IronPDF は PDF の作成をサポートするだけでなく、PDF を編集、セキュリティ保護、他のフォーマットに変換する機能も提供します。

これには、テキストや画像の抽出、フォームの記入、デジタル署名の適用が可能であり、.NET アプリケーション内での PDF ドキュメントの包括的な処理を保証します。

using IronPdf;
using System;

class Program
{
    static void Main(string[] args)
    {
        // Set your IronPDF license key
        License.LicenseKey = "License-Key";

        // Initialize the value
        int totalSales = 150;

        // Modify the value within the method using 'ref'
        AddMonthlyBonus(ref totalSales);

        // Use IronPDF to generate a PDF report
        var Renderer = new ChromePdfRenderer();
        var PDF = Renderer.RenderHtmlAsPdf($"<h1>Monthly Sales Report</h1><p>Total Sales, including bonus: {totalSales}</p>");

        // Save the PDF to a file
        PDF.SaveAs("MonthlySalesReport.pdf");

        // Confirm the PDF has been generated
        Console.WriteLine("PDF generated successfully. Check your project directory.");
    }

    // Method that adds a monthly bonus to sales using 'ref'
    static void AddMonthlyBonus(ref int sales)
    {
        // Assume a bonus of 10% of the sales
        sales += (int)(sales * 0.1);
    }
}

using IronPdf;
using System;

class Program
{
    static void Main(string[] args)
    {
        // Set your IronPDF license key
        License.LicenseKey = "License-Key";

        // Initialize the value
        int totalSales = 150;

        // Modify the value within the method using 'ref'
        AddMonthlyBonus(ref totalSales);

        // Use IronPDF to generate a PDF report
        var Renderer = new ChromePdfRenderer();
        var PDF = Renderer.RenderHtmlAsPdf($"<h1>Monthly Sales Report</h1><p>Total Sales, including bonus: {totalSales}</p>");

        // Save the PDF to a file
        PDF.SaveAs("MonthlySalesReport.pdf");

        // Confirm the PDF has been generated
        Console.WriteLine("PDF generated successfully. Check your project directory.");
    }

    // Method that adds a monthly bonus to sales using 'ref'
    static void AddMonthlyBonus(ref int sales)
    {
        // Assume a bonus of 10% of the sales
        sales += (int)(sales * 0.1);
    }
}

Imports IronPdf
Imports System

Friend Class Program
	Shared Sub Main(ByVal args() As String)
		' Set your IronPDF license key
		License.LicenseKey = "License-Key"

		' Initialize the value
		Dim totalSales As Integer = 150

		' Modify the value within the method using 'ref'
		AddMonthlyBonus(totalSales)

		' Use IronPDF to generate a PDF report
		Dim Renderer = New ChromePdfRenderer()
		Dim PDF = Renderer.RenderHtmlAsPdf($"<h1>Monthly Sales Report</h1><p>Total Sales, including bonus: {totalSales}</p>")

		' Save the PDF to a file
		PDF.SaveAs("MonthlySalesReport.pdf")

		' Confirm the PDF has been generated
		Console.WriteLine("PDF generated successfully. Check your project directory.")
	End Sub

	' Method that adds a monthly bonus to sales using 'ref'
	Private Shared Sub AddMonthlyBonus(ByRef sales As Integer)
		' Assume a bonus of 10% of the sales
		sales += CInt(Math.Truncate(sales * 0.1))
	End Sub
End Class

結論

C#のrefキーワードを理解することは、メソッド間でデータがどのように渡されるかを管理するための貴重なツールとなります。 メソッドが渡されたパラメータの元の値を直接変更できるようにすることで、refはメソッドをより柔軟で強力なものにすることができます。

refについての経験を積むと、それを効果的に使用するための適切なタイミングと方法をよりよく理解するようになります。 IronPDFは無料トライアルでPDF機能を始めることができ、価格は$999からです。