C# Out 参数（开发者指南）

1. 简化方法

通过使用out参数，您可以避免创建复杂的返回类型，如自定义对象或元组，以封装多个结果。 这导致了更清晰、更具可读性的代码。 您可以使用多个out参数直接返回最重要的值，而不是返回包含多个属性的单个对象。

2. 简明且可读的代码

Out参数通过允许开发人员在主要结果旁返回附加数据（如处理状态、错误或其他上下文信息）使代码简洁且易于维护。 例如，在生成PDF时，您可能想返回成功状态和指示操作结果的一条消息。

3. 增强的灵活性

Out参数使您能够轻松地从被调用的方法返回多个结果，而无需复杂的类结构。 在PDF处理任务中，这可能尤为有用，例如需要提取并返回文本内容和元数据，或需要的重要状态信息用于处理错误和确认操作。

语法和定义

要声明一个out参数，您需要在方法签名中使用out关键字。 调用者在调用方法时也必须使用out关键字，以区别于普通参数。

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

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

在这种情况下，result参数必须在方法内部被赋值，并且一旦方法完成，调用者将收到更新后的值。

为了展示变量声明的灵活性，您还可以在调用方法时使用隐式类型本地变量：

int result;
ExampleMethod(out result);

int result;
ExampleMethod(out result);

常见用例

• 返回状态码或错误信息：通常用于处理数据并需要返回附加反馈的方法中。
• 提取多个值：非常适合方法返回多个值的情况，例如处理PDF文档时。
• 通过避免多次调用来提高性能：通过使用out参数，您可以避免多次调用方法来检索相关信息片段。

优势和限制

优势：

• 高效地返回多个结果。
• 不需要复杂的返回类型（例如元组、列表）简化代码。
• 通过减少多次方法调用的需要提高性能。

限制：

• 在使用过多out参数时，会使方法参数列表更复杂。
• 过度使用out参数可能会降低代码的整体可读性和可维护性。

场景1：从PDF文件中提取文本

Out参数可用于提取文本，并返回附加数据，如文档中的页数。 这在处理大文档或需要衡量文本提取性能时很有帮助。

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}");
    }
}

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

IronPDF可以用于验证PDF元数据并处理可能出现的错误。 Out参数是返回元数据和在验证过程中遇到的任何错误信息的理想选择。 例如，这里我们使用它从一个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}");
}

场景3：生成和保存PDF

从HTML内容生成PDF时，out参数可以用于捕获结果并提供成功或错误消息，从而增强最终用户的反馈。

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);
}