What do ref, val and out mean on method parameters?

by

By default (in C#), passing an object to a function actually passes a copy of the reference to that object. Changing the parameter itself only changes the value in the parameter, and not the variable that was specified.

void Test1(string param)
{
    param = "new value";
}

string s1 = "initial value";
Test1(s1);
// s1 == "initial value"

Using out or ref passes a reference to the variable specified in the call to the function. Any changes to the value of an out or ref parameter will be passed back to the caller.

Both out and ref behave identically except for one slight difference: ref parameters are required to be initialised before calling, while out parameters can be uninitialised. By extension, ref parameters are guaranteed to be initialised at the start of the method, while out parameters are treated as uninitialised.

void Test2(ref string param)
{
    param = "new value";
}

void Test3(out string param)
{
    // Use of param here will not compile
    param = "another value";
}

string s2 = "initial value";
string s3;
Test2(ref s2);
// s2 == "new value"
// Test2(ref s3); // Passing ref s3 will not compile
Test3(out s2);
// s2 == "another value"
Test3(out s3);
// s3 == "another value"

Edit: As dp points out, the difference between out and ref is only enforced by the C# compiler, not by the CLR. As far as I know, VB has no equivalent for out and implements ref (as ByRef) only, matching the support of the CLR.

More Related Contents:

  1. VB Net Class in C# [closed]
  2. What is a NullReferenceException, and how do I fix it?
  3. Setting Objects to Null/Nothing after use in .NET
  4. Custom Compiler Warnings
  5. Difference in months between two dates
  6. Way to have String.Replace only hit “whole words”
  7. When is a custom attribute’s constructor run?
  8. Capture screenshot Including Semitransparent windows in .NET
  9. How do I determine a mapped drive’s actual path?
  10. Get File Icon used by Shell
  11. Difference with Parameters.Add and Parameters.AddWithValue
  12. How to find overlapping controls that I added to form?
  13. How to flatten nested objects with linq expression
  14. Inconsistency in divide-by-zero behavior between different value types
  15. Is String a primitive type?
  16. What is a predicate in c#? [duplicate]
  17. Winforms: Application.Exit vs Environment.Exit vs Form.Close
  18. Install to same path when upgrading application
  19. BinaryWriter Endian issue
  20. Get the SourceControl of a DropDownMenu
  21. .NET Configuration (app.config/web.config/settings.settings)
  22. Compare compiled .NET assemblies?
  23. How to Start a Process Unelevated
  24. Save Settings in VB.Net or C#
  25. .NET graph library around? [closed]
  26. center MessageBox in parent form [duplicate]
  27. How do you disable an item in listview control in .net 3.5
  28. What ‘length’ parameter should I pass to SqlDataReader.GetBytes()
  29. List of exceptions that CAN’T be caught in .NET
  30. Detecting remote desktop connection

Leave a Comment