Passing a property as an 'out' parameter in C#

C#PropertiesOut Parameters

C# Problem Overview


Suppose I have:

public class Bob
{
    public int Value { get; set; }
}

I want to pass the Value member as an out parameter like

Int32.TryParse("123", out bob.Value);

but I get a compilation error, "'out' argument is not classified as a variable." Is there any way to achieve this, or am I going to have to extract a variable, à la:

int value;
Int32.TryParse("123", out value);
bob.Value = value;

C# Solutions


Solution 1 - C#

You'd have to explicitly use a field and "normal" property instead of an auto-implemented property:

public class Bob
{
    private int value;
    public int Value
    { 
        get { return value; } 
        set { this.value = value; }
    }
}

Then you can pass the field as an out parameter:

Int32.TryParse("123", out bob.value);

But of course, that will only work within the same class, as the field is private (and should be!).

Properties just don't let you do this. Even in VB where you can pass a property by reference or use it as an out parameter, there's basically an extra temporary variable.

If you didn't care about the return value of TryParse, you could always write your own helper method:

static int ParseOrDefault(string text)
{
    int tmp;
    int.TryParse(text, out tmp);
    return tmp;
}

Then use:

bob.Value = Int32Helper.ParseOrDefault("123");

That way you can use a single temporary variable even if you need to do this in multiple places.

Solution 2 - C#

You can achieve that, but not with a property.

public class Bob {
    public int Value { get; set; } // This is a property

    public int AnotherValue; // This is a field
}

You cannot use out on Value, but you can on AnotherValue.

This will work

Int32.TryParse("123", out bob.AnotherValue);

But, common guidelines tells you not to make a class field public. So you should use the temporary variable approach.

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionthorncpView Question on Stackoverflow
Solution 1 - C#Jon SkeetView Answer on Stackoverflow
Solution 2 - C#Pierre-Alain VigeantView Answer on Stackoverflow