When should I use out parameters?

by

Out is good when you have a TryNNN function and it’s clear that the out-parameter will always be set even if the function does not succeed. This allows you rely on the fact that the local variable you declare will be set rather than having to place checks later in your code against null. (A comment below indicates that the parameter could be set to null, so you may want to verify the documentation for the function you’re calling to be sure if this is the case or not.) It makes the code a little clearer and easier to read. Another case is when you need to return some data and a status on the condition of the method like:

public bool DoSomething(int arg1, out string result);

In this case the return can indicate if the function succeeded and the result is stored in the out parameter. Admittedly, this example is contrived because you can design a way where the function simply returns a string, but you get the idea.

A disadvantage is that you have to declare a local variable to use them:

string result;
if (DoSomething(5, out result))
    UpdateWithResult(result);

Instead of:

UpdateWithResult(DoSomething(5));

However, that may not even be a disadvantage, it depends on the design you’re going for. In the case of DateTime, both means (Parse and TryParse) are provided.

More Related Contents:

  1. How do you sort a dictionary by value?
  2. Make an Installation program for C# applications and include .NET Framework installer into the setup
  3. AddBusinessDays and GetBusinessDays
  4. Is there an alternative to string.Replace that is case-insensitive?
  5. Why DateTime.AddHours doesn’t seem to work?
  6. How to check whether an object has certain method/property?
  7. Can I optionally turn off the JsonIgnore attribute at runtime?
  8. WPF: How do I loop through the all controls in a window?
  9. Is String a primitive type?
  10. Is there any connection string parser in C#?
  11. why does DateTime.ToString(“dd/MM/yyyy”) give me dd-MM-yyyy?
  12. BinaryWriter Endian issue
  13. Call and consume Web API in winform using C#.net
  14. Why generic IList does not inherit non-generic IList
  15. Collection was modified; enumeration may not execute error when removing a ListItem from a LIstBox
  16. How to check the Internet connection with .NET, C#, and WPF
  17. Converting String To Float in C#
  18. How to compare only Date without Time in DateTime types?
  19. When or if to Dispose HttpResponseMessage when calling ReadAsStreamAsync?
  20. Use the XmlInclude or SoapInclude attribute to specify types that are not known statically
  21. Days, hours, minutes, seconds between two dates
  22. Selenium WebDriver throws Timeout exceptions sporadically
  23. Create custom shape for button
  24. Auto-width of ComboBox’s content
  25. Convert Date from Persian to Gregorian
  26. The ObjectContext instance has been disposed and can no longer be used for operations that require a connection [duplicate]
  27. When should one use Environment.Exit to terminate a console application?
  28. How to get the screenshot of the form
  29. Web Service without adding a reference?
  30. How to Print Preview when using a DocumentPaginator to print?

Leave a Comment