C# 輸出參數（工作原理：開發者指南）

1. 方法的簡化

透過使用輸出參數，您可以避免建立複雜的回傳類型（例如自訂物件或元組）來封裝多個結果。 這樣可以寫出更簡潔、更易讀的程式碼。 你可以使用多個輸出參數直接傳回最重要的值，而不是傳回包含多個屬性的單一物件。

2. 簡潔易讀的程式碼

輸出參數允許開發人員在主要結果之外返回附加資料（例如，處理狀態、錯誤或其他上下文資訊），從而使程式碼簡潔且易於維護。 例如，在產生 PDF 時，您可能希望同時傳回成功狀態和指示操作結果的訊息。

3. 增強的靈活性

輸出參數使得從被呼叫方法傳回多個結果變得容易，而無需複雜的類別結構。 這在 PDF 處理任務中尤其有用，因為您可能需要提取和返回文字內容和元數據，或者額外的狀態資訊對於處理錯誤和確認操作至關重要。

語法和定義

要宣告一個輸出參數，需要在方法簽章中使用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 文件時，這是理想的選擇。 *透過避免多次呼叫來提高效能：輸出參數可讓您避免多次呼叫方法來檢索相關資訊。

優點與局限性

優勢：

• 能夠有效率地傳回多個結果。
• 簡化程式碼，無需複雜的回傳類型（例如，元組、清單）。
• 透過減少多次方法呼叫來提高效能。

局限性：

• 可能會使方法參數清單變得更加複雜，尤其是在使用過多輸出參數的情況下。
• 過度使用輸出參數可能會降低程式碼的整體可讀性和可維護性。

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

C# 輸出參數（工作原理：開發者指南）：圖 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}");
}

C# 輸出參數（工作原理：開發者指南）：圖 4

場景三：產生並儲存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);
}

C# 輸出參數（工作原理：開發者指南）：圖 5