.NET 帮助

C# 输出参数（工作原理：开发者指南）

坎那帕·乌东攀

2025年二月19日

介绍

在 .NET 开发领域，编写简洁且可维护的代码时，效率和可读性至关重要。一个强大的功能是使用C#，这对两者都有贡献输出参数. 输出参数允许方法返回多个值，使其成为需要附加上下文或数据的场景中的理想选择。当与IronPDF结合使用时，这个强大的库可用于在C#中创建、编辑和处理PDF文件，out参数可以显著简化复杂的工作流程。

IronPDF通过提供全面的功能集，例如提取文本、操作元数据和将HTML转换为PDF，简化了PDF的使用。通过利用 out 参数和 IronPDF，开发人员不仅可以高效地执行这些任务，还可以返回有价值的信息。(如处理状态、错误信息或附加元数据)在实际应用中可能至关重要。

本文探讨了C#中的输出参数概念，并演示了如何将它们与IronPDF结合使用，以改善您的PDF相关工作流程。无论是提取内容、验证文件还是生成PDF，您都将看到使用 out 参数如何简化代码并增强其功能。

C# out 参数是什么？

输出参数是C#中一个独特的特性，允许方法同时返回多个值。这在需要从方法返回多个信息但又不想将数据封装在像类或元组这样的复杂结构中时非常有用。

与按引用或按值传递值的常规参数不同，out参数必须在方法返回之前在方法体内显式赋值。这确保了当方法执行完毕时，调用代码将接收到预期的输出。

void ExampleMethod(out int result)
{
    result = 42; // Assigning a value is mandatory
}
int value;
ExampleMethod(out value);
Console.WriteLine(value); // Outputs: 42

void ExampleMethod(out int result)
{
    result = 42; // Assigning a value is mandatory
}
int value;
ExampleMethod(out value);
Console.WriteLine(value); // Outputs: 42

Private Sub ExampleMethod(ByRef result As Integer)
	result = 42 ' Assigning a value is mandatory
End Sub
Private value As Integer
ExampleMethod(value)
Console.WriteLine(value) ' Outputs: 42

$vbLabelText $csharpLabel

如示例所示，变量值通过 out 关键字传递给 ExampleMethod。在方法内部，结果被赋值为42，当方法执行完毕时，这个值会在输出变量中反映出来。请注意，该值是在单独的变量声明格式中定义的，其中变量是在传递给方法之前声明的。

输出参数通常用于以下场景：

返回状态代码或错误消息。
提取多个值的返回多个值的方法。
提供其他上下文，例如处理信息或元数据。

IronPDF 概览

C# 输出参数（其工作原理：开发人员指南）：图1

IronPDF是一个多功能且强大的.NET库，专为处理PDF文档而设计。无论您需要从 HTML 生成 PDF、操作现有 PDF 还是从中提取内容，IronPDF 提供了简单明了的 API，使开发人员可以专注于应用程序的逻辑，而不是处理 PDF 的复杂性。

IronPDF 简化了常见任务，例如：

将 HTML 转换为 PDF：轻松渲染将 HTML 转换为 PDF 文档, 保留样式和内容。
提取文本和图像Extract Content从PDF文件中，包括所有文本、图像和其他媒体。
操作PDF文件：通过编辑PDF文件添加页面修改内容或追加元数据.
处理PDF表单：Fill out the form或从交互式PDF表单中提取数据。
处理加密的PDF：打开并使用密码保护或加密PDF 文件。
将IronPDF与C# out参数结合使用，可以从方法中返回多条数据，如提取的文本、页数或元数据，而不会使方法的签名复杂化。

为什么将输出参数与IronPDF结合使用？

将输出参数与IronPDF集成为开发人员提供了几个关键优势：

方法简化

通过使用输出参数，您可以避免创建复杂的返回类型，例如自定义对象或元组，以封装多个结果。这使代码更加简洁、可读。与其返回一个包含多个属性的单一对象，不如使用多个输出参数或单个输出参数，直接返回最重要的值。

2. 简洁且可读的代码

输出参数通过允许开发者返回额外的数据，使代码简洁且便于维护(例如，处理状态、错误或其他上下文信息)以及主要结果例如，在生成PDF时，您可能希望返回成功状态以及指示操作结果的消息。

3. 增强的灵活性

使用 out 参数可以轻松地从被调用的方法返回多个结果，而无需复杂的类结构。这在PDF处理任务中特别有用，在这些任务中，您可能需要提取并返回文本内容和元数据，或者在处理错误和确认操作时，附加的状态信息至关重要。

理解 C# 输出参数

在方法定义和调用方法时都要声明 out 参数。它们与常规参数的不同之处在于，调用者不需要在将变量传递给方法之前对其进行初始化。相反，该方法本身将为 out 变量分配值。

在C#中，参数可以通过值传递、通过引用传递或使用out关键字传递。当通过引用传递参数时，你允许方法修改原始变量，并且必须使用 ref 关键字或 out 关键字声明参数。然而，它们的用途不同。

当你希望从一个方法中返回多个值，但调用者不需要事先初始化变量时，可以使用 out 参数。这些变量必须在方法内部被赋值，然后才能将控制权返回给调用代码。
引用参数(使用 ref 关键字声明)也允许方法修改传递的变量，但关键区别在于调用者必须在将变量传递给方法之前对其进行初始化。当您想将变量传递给方法并对其进行修改，但又需要调用者了解其原始状态时，使用ref参数。

语法和定义

要声明一个 out 参数，可以在方法签名中使用 out 关键字。调用方在调用方法时还必须使用 out 关键字，这与常规参数有所区别。

void ExampleMethod(out int result)
{
    result = 42;
}

void ExampleMethod(out int result)
{
    result = 42;
}

Private Sub ExampleMethod(ByRef result As Integer)
	result = 42
End Sub

$vbLabelText $csharpLabel

在这种情况下，必须在方法内为结果参数赋值，一旦方法完成，调用者将收到更新后的值。

要在变量声明中显示灵活性，可以在调用方法时使用隐式类型的局部变量：

var result;
ExampleMethod(out result);

var result;
ExampleMethod(out result);

Dim result = Nothing
ExampleMethod(result)

$vbLabelText $csharpLabel

常见用例

返回状态代码或错误消息：通常在处理大型数据集并且需要在每个步骤返回额外反馈的迭代器方法中使用。
提取多个值：适用于方法返回多个值的情况，例如在处理PDF文档时。
通过避免多次调用来提高性能：Out 参数可以让您避免多次方法调用以获取相关信息。

优势和局限

优点：

高效地返回多个结果。
在不需要复杂返回类型的情况下简化代码(例如，元组，列表).
通过减少多次方法调用的需求来提高性能。
限制：
如果使用了太多的输出参数，可能会使方法参数列表变得更加复杂。
过度使用输出参数可能会降低代码的整体可读性和可维护性。

代码演练：使用输出参数提取文本

步骤 1：在您的项目中设置 IronPDF

要开始使用IronPDF，请安装IronPDF NuGet包：

Install-Package IronPdf

Install-Package IronPdf

'INSTANT VB TODO TASK: The following line uses invalid syntax:
'Install-Package IronPdf

$vbLabelText $csharpLabel

步骤2：定义带有输出参数的方法

接下来，定义一个方法，从 PDF 中提取文本并使用输出参数返回页面数量：

void ExtractTextWithPageCount(string pdfPath, out string extractedText, out int pageCount)
{
    var pdfDocument = PdfDocument.FromFile(pdfPath);
    extractedText = pdfDocument.ExtractAllText();
    pageCount = pdfDocument.PageCount;
}

void ExtractTextWithPageCount(string pdfPath, out string extractedText, out int pageCount)
{
    var pdfDocument = PdfDocument.FromFile(pdfPath);
    extractedText = pdfDocument.ExtractAllText();
    pageCount = pdfDocument.PageCount;
}

Private Sub ExtractTextWithPageCount(ByVal pdfPath As String, ByRef extractedText As String, ByRef pageCount As Integer)
	Dim pdfDocument = PdfDocument.FromFile(pdfPath)
	extractedText = pdfDocument.ExtractAllText()
	pageCount = pdfDocument.PageCount
End Sub

$vbLabelText $csharpLabel

步骤 3：实现和测试方法

最后，调用该方法并显示提取的文本和页数：

string text;
int pages;
ExtractTextWithPageCount("sample.pdf", out text, out pages);
Console.WriteLine($"Extracted Text: {text}\nPages: {pages}");

string text;
int pages;
ExtractTextWithPageCount("sample.pdf", out text, out pages);
Console.WriteLine($"Extracted Text: {text}\nPages: {pages}");

Imports Microsoft.VisualBasic

Dim text As String = Nothing
Dim pages As Integer = Nothing
ExtractTextWithPageCount("sample.pdf", text, pages)
Console.WriteLine($"Extracted Text: {text}" & vbLf & "Pages: {pages}")

$vbLabelText $csharpLabel

C# Out 参数（开发人员指南：它如何工作）：图 2

使用IronPDF和Out参数的实际场景

方案1：从PDF文件中提取文本

可以使用输出参数提取文本，并返回附加数据，例如文档中的页数。这在处理大型文档或需要测量文本提取性能时非常有用。

using IronPdf;
public class Program
{
    public static void Main(string[] args)
    {
        void ExtractTextWithPageCount(string pdfPath, out string extractedText, out int pageCount)
        {
            var pdfDocument = PdfDocument.FromFile(pdfPath);
            extractedText = pdfDocument.ExtractAllText();
            pageCount = pdfDocument.PageCount;
        }
        string text;
        int pages;
        ExtractTextWithPageCount("sample.pdf", out text, out pages);
        Console.WriteLine($"Extracted Text: {text}\nPages: {pages}");
    }
}

using IronPdf;
public class Program
{
    public static void Main(string[] args)
    {
        void ExtractTextWithPageCount(string pdfPath, out string extractedText, out int pageCount)
        {
            var pdfDocument = PdfDocument.FromFile(pdfPath);
            extractedText = pdfDocument.ExtractAllText();
            pageCount = pdfDocument.PageCount;
        }
        string text;
        int pages;
        ExtractTextWithPageCount("sample.pdf", out text, out pages);
        Console.WriteLine($"Extracted Text: {text}\nPages: {pages}");
    }
}

Imports Microsoft.VisualBasic
Imports IronPdf
Public Class Program
	Public Shared Sub Main(ByVal args() As String)
'INSTANT VB TODO TASK: Local functions are not converted by Instant VB:
'		void ExtractTextWithPageCount(string pdfPath, out string extractedText, out int pageCount)
'		{
'			var pdfDocument = PdfDocument.FromFile(pdfPath);
'			extractedText = pdfDocument.ExtractAllText();
'			pageCount = pdfDocument.PageCount;
'		}
		Dim text As String = Nothing
		Dim pages As Integer = Nothing
		ExtractTextWithPageCount("sample.pdf", text, pages)
		Console.WriteLine($"Extracted Text: {text}" & vbLf & "Pages: {pages}")
	End Sub
End Class

$vbLabelText $csharpLabel

C# Out 参数（工作原理：开发人员指南）：图 3

场景2：验证和导出PDF元数据

IronPDF可以用于验证PDF元数据和处理潜在错误。输出参数非常适合返回元数据以及在验证过程中遇到的任何错误消息。例如，这里我们使用它从PDF文档中检索作者元数据值：

bool ValidateAndExportMetadata(string pdfPath, out string author, out string errorMessage)
{
    try
    {
        var pdfDocument = PdfDocument.FromFile(pdfPath);
        author = pdfDocument.MetaData.Author;
        errorMessage = null;
        return true;
    }
    catch (Exception ex)
    {
        author = null;
        errorMessage = ex.Message;
        return false;
    }
}
string metadata;
string error;
if (ValidateAndExportMetadata("metadata.pdf", out metadata, out error))
{
    Console.WriteLine($"Metadata: {metadata}");
}
else
{
    Console.WriteLine($"Error: {error}");
}

bool ValidateAndExportMetadata(string pdfPath, out string author, out string errorMessage)
{
    try
    {
        var pdfDocument = PdfDocument.FromFile(pdfPath);
        author = pdfDocument.MetaData.Author;
        errorMessage = null;
        return true;
    }
    catch (Exception ex)
    {
        author = null;
        errorMessage = ex.Message;
        return false;
    }
}
string metadata;
string error;
if (ValidateAndExportMetadata("metadata.pdf", out metadata, out error))
{
    Console.WriteLine($"Metadata: {metadata}");
}
else
{
    Console.WriteLine($"Error: {error}");
}

Private Function ValidateAndExportMetadata(ByVal pdfPath As String, ByRef author As String, ByRef errorMessage As String) As Boolean
	Try
		Dim pdfDocument = PdfDocument.FromFile(pdfPath)
		author = pdfDocument.MetaData.Author
		errorMessage = Nothing
		Return True
	Catch ex As Exception
		author = Nothing
		errorMessage = ex.Message
		Return False
	End Try
End Function
Private metadata As String
Private [error] As String
If ValidateAndExportMetadata("metadata.pdf", metadata, [error]) Then
	Console.WriteLine($"Metadata: {metadata}")
Else
	Console.WriteLine($"Error: {[error]}")
End If

$vbLabelText $csharpLabel

C# Out 参数（它是如何工作的：开发人员指南）：图 4

场景 3：生成和保存 PDF

从 HTML 内容生成 PDF 时，可以使用输出参数来捕获结果并提供成功或错误信息，从而改善最终用户的反馈。

bool GenerateAndSavePdf(string htmlContent, string outputPath, out string statusMessage)
{
    try
    {
        ChromePdfRenderer renderer = new ChromePdfRenderer();
        var pdf = renderer.RenderHtmlAsPdf(htmlContent);
        pdf.SaveAs(outputPath);
        statusMessage = "PDF successfully saved.";
        return true;
    }
    catch (Exception ex)
    {
        statusMessage = $"Error: {ex.Message}";
        return false;
    }
}
string message;
if (GenerateAndSavePdf("<h1>Hello, World!</h1>", "output.pdf", out message))
{
    Console.WriteLine(message);
}
else
{
    Console.WriteLine(message);
}

bool GenerateAndSavePdf(string htmlContent, string outputPath, out string statusMessage)
{
    try
    {
        ChromePdfRenderer renderer = new ChromePdfRenderer();
        var pdf = renderer.RenderHtmlAsPdf(htmlContent);
        pdf.SaveAs(outputPath);
        statusMessage = "PDF successfully saved.";
        return true;
    }
    catch (Exception ex)
    {
        statusMessage = $"Error: {ex.Message}";
        return false;
    }
}
string message;
if (GenerateAndSavePdf("<h1>Hello, World!</h1>", "output.pdf", out message))
{
    Console.WriteLine(message);
}
else
{
    Console.WriteLine(message);
}

Private Function GenerateAndSavePdf(ByVal htmlContent As String, ByVal outputPath As String, ByRef statusMessage As String) As Boolean
	Try
		Dim renderer As New ChromePdfRenderer()
		Dim pdf = renderer.RenderHtmlAsPdf(htmlContent)
		pdf.SaveAs(outputPath)
		statusMessage = "PDF successfully saved."
		Return True
	Catch ex As Exception
		statusMessage = $"Error: {ex.Message}"
		Return False
	End Try
End Function
Private message As String
If GenerateAndSavePdf("<h1>Hello, World!</h1>", "output.pdf", message) Then
	Console.WriteLine(message)
Else
	Console.WriteLine(message)
End If

$vbLabelText $csharpLabel

C# out 参数（如何运作：开发者指南）：图 5

使用输出参数的最佳实践

何时在 IronPDF 中使用输出参数

当额外的上下文（例如错误消息或处理状态）至关重要时，使用输出参数。例如，如果一个方法负责生成PDF，则返回状态消息和生成的PDF路径可以为用户或调用应用程序提供必要的反馈。

避免过度使用输出参数

虽然 out 参数很有用，但避免在单个方法中过度使用它们是很重要的。如果您发现自己使用了太多的输出参数，那么可以考虑返回一个自定义对象或元组，以更清晰地封装数据。

处理异常和边界情况

始终验证输入并适当处理异常。确保 out 参数使用合理的默认值进行初始化(例如，字符串用 null，整数用 0)防止意外行为。 IronPDF 方法可能会抛出异常，因此正确的异常处理至关重要。

结论

C# 的 out 参数是一个强大的功能，用于从方法返回多个值。与IronPDF一起使用时，它们可以简化复杂的PDF工作流程，让您高效提取文本、验证元数据，并在生成PDF的同时提供有价值的反馈。通过遵循最佳实践和谨慎使用 out 参数，您可以为 PDF 处理任务创建高效、可维护且易于理解的代码。

要探索IronPDF的全部功能，请下载免费试用并立即开始将其集成到您的.NET项目中。快乐编程!

坎那帕·乌东攀

立即与工程团队聊天

软件工程师

在成为软件工程师之前，Kannapat 从日本北海道大学完成了环境资源博士学位。在攻读学位期间，Kannapat 还成为了生物生产工程系车辆机器人实验室的成员。2022年，他利用自己的 C# 技能加入了 Iron Software 的工程团队，专注于 IronPDF。Kannapat 珍视他的工作，因为他能直接向编写 IronPDF 大部分代码的开发者学习。除了同伴学习，Kannapat 还享受在 Iron Software 工作的社交方面。不写代码或文档时，Kannapat 通常在 PS5 上玩游戏或重看《最后生还者》。

< 前一页
C# Directory.GetFiles（工作原理：开发人员指南）

下一步 >
C# 匿名对象（开发者如何使用）