اصلاحگر پارامتر out

کلمه کلیدی out باعث می شود که آرگومان ها بصورت مرجع ، پاس داده شوند. این کلیدواژه شبیه کلمه کلیدی ref است ، بجز اینکه ref نیاز دارد که متغیر قبل پاس دادن، مقدار دهی اولیه شده باشد. برای استفاده از یک پارامتر out، تعریف متد و فراخوانی متد ، هر باید از کلمه کلیدی out صریحا" استفاده کنند. برای مثال:

class OutExample
{
    static void Method(out int i)
    {
        i = 44;
    }
    static void Main()
    {
        int value;
        Method(out value);
        // value is now 44
    }
}

هرچند متغیرهایی که بصورت آرگومان out پاس داده شده اند مجبور نیستند که قبل از پاس داده شدن مقداردهی اولیه شوند، ولی متد فراخوانی شده، لازم است که قبل از اینکه متد برگردد (با دستور return یا پایان متد) یک مقدار به آنها انتساب دهد.

با اینکه کلمات کلیدی out و ref باعث رفتار های متفاوتی در زمان اجرا می شوند، به عنوان قسمتی از امضای متد در زمان کامپایل محسوب نمی شوند. بنابراین ، متد هایی که تنها تفاوت آنها در این است که یکی آرگومان out دارد و دیگری آرگومان ref ، نمی توانند overload شوند. مثلا" کد زیر کامپایل نخواهد شد:

class CS0663_Example
{
    // Compiler error CS0663: "Cannot define overloaded 
    // methods that differ only on ref and out".
    public void SampleMethod(out int i) { }
    public void SampleMethod(ref int i) { }
}

عمل overload حتی اگر یکی از متدها دارای آرگومان out یا ref باشد و دیگری نباشد، می تواند انجام گیرد، مثل این:

class OutOverloadExample
{
    public void SampleMethod(int i) { }
    public void SampleMethod(out int i) { i = 5; }
}

پراپرتی ها متغیر نیستند، بنابراین نمی توان آنها را بصورت آرگومان out به متد پاس داد.

مثال

اعلان متد out در مواقعی که می خواهید متد چندین مقدار را برگشت دهد، مفید است. مثال زیر از out برای برگشت دادن سه متغیر با استفاده از فراخوانی یک متد ، استفاده می کند. دقت کنید که آرگومان سوم به null منتسب شده است که به متد این امکان را می دهد که به دلخواه مقادیر را برگشت دهد.

class OutReturnExample
{
    static void Method(out int i, out string s1, out string s2)
    {
        i = 44;
        s1 = "I've been returned";
        s2 = null;
    }
    static void Main()
    {
        int value;
        string str1, str2;
        Method(out value, out str1, out str2);
        // value is now 44
        // str1 is now "I've been returned"
        // str2 is (still) null;
    }
}