Why use the ‘ref’ keyword when passing an object?

by

Pass a ref if you want to change what the object is:

TestRef t = new TestRef();
t.Something = "Foo";
DoSomething(ref t);

void DoSomething(ref TestRef t)
{
  t = new TestRef();
  t.Something = "Not just a changed t, but a completely different TestRef object";
}

After calling DoSomething, t does not refer to the original new TestRef, but refers to a completely different object.

This may be useful too if you want to change the value of an immutable object, e.g. a string. You cannot change the value of a string once it has been created. But by using a ref, you could create a function that changes the string for another one that has a different value.

It is not a good idea to use ref unless it is needed. Using ref gives the method freedom to change the argument for something else, callers of the method will need to be coded to ensure they handle this possibility.

Also, when the parameter type is an object, then object variables always act as references to the object. This means that when the ref keyword is used you’ve got a reference to a reference. This allows you to do things as described in the example given above. But, when the parameter type is a primitive value (e.g. int), then if this parameter is assigned to within the method, the value of the argument that was passed in will be changed after the method returns:

int x = 1;
Change(ref x);
Debug.Assert(x == 5);
WillNotChange(x);
Debug.Assert(x == 5); // Note: x doesn't become 10

void Change(ref int x)
{
  x = 5;
}

void WillNotChange(int x)
{
  x = 10;
}

More Related Contents:

  1. What is a method group in C#?
  2. When should I use a List vs a LinkedList
  3. C# getting the path of %AppData%
  4. Getting multiple keys of specified value of a generic Dictionary?
  5. Capture the Screen into a Bitmap
  6. How can I register a global hot key to say CTRL+SHIFT+(LETTER) using WPF and .NET 3.5?
  7. Detecting USB drive insertion and removal using windows service and c#
  8. How can I create a self-signed certificate using C#?
  9. Convert string[] to int[] in one line of code using LINQ
  10. Create instance of generic type whose constructor requires a parameter?
  11. How to limit the Maximum number of parallel tasks in c#
  12. How to call a VBScript file in a C# application?
  13. Why do BCL Collections use struct enumerators, not classes?
  14. Absolute path back to web-relative path
  15. Benefits of using async and await keywords
  16. Entity Framework with XML Files [closed]
  17. how to convert NameValueCollection to JSON string?
  18. WPF How to access control from DataTemplate
  19. When using a Settings.settings file in .NET, where is the config actually stored?
  20. HttpWebRequest & Native GZip Compression
  21. Destructor vs IDisposable?
  22. Identifying a custom indexer using reflection in C#
  23. Initialize library on Assembly load
  24. How to prevent duplicate values in enum?
  25. How to register Windows Forms with Simple Injector
  26. Uninstall Custom Action Not Deleting Registry Key
  27. How can I remove empty xmlns attribute from node created by XElement
  28. (0 == variable) or (null == obj): An outdated practice in C#? [duplicate]
  29. C# generic methods, type parameters in new() constructor constraint
  30. Adjust brightness, contrast and gamma of an image

Leave a Comment