What is a NullReferenceException, and how do I fix it?

Multi tool use
What is a NullReferenceException, and how do I fix it?
I have some code and when it executes, it throws a NullReferenceException
, saying:
NullReferenceException
Object reference not set to an instance of an object.
What does this mean, and what can I do to fix this error?
This question's answers are a collaborative effort: if you see something that can be improved, just edit the answer to improve it! No additional answers can be added here
Cant we just say "object has not been initialized"? So if you have a variable declaration: SomeClass myVariable; this will create myVariable with reference to SomeClass, but it is Not initialized and will be equal to null. You have to invoke the class initialization by doing SomeClass myVariable = new SomeClass(); Or, if you are returning a reference to another variable: SomeClass myVariable = anotherVariableDeclared();
– Arvin Amir
Jun 7 '17 at 0:06
@Arvin what about `MfClass
– John Saunders
Jun 7 '17 at 18:15
Dear future visitors, the answers to this question equally apply to an ArgumentNullException. If your question has been closed as a duplicate of this one, and you are experiencing an ANE, please follow the directions in the answers to debug and fix your problem.
– Will
Oct 13 '17 at 17:56
@will ANE should only happen if a null is passed as a parameter. Can you give an example if an ANE question closed as a duplicate of this one?
– John Saunders
Oct 14 '17 at 21:44
33 Answers
33
What is the cause?
You are trying to use something that is null
(or Nothing
in VB.NET). This means you either set it to null
, or you never set it to anything at all.
null
Nothing
null
Like anything else, null
gets passed around. If it is null
in method "A", it could be that method "B" passed a null
to method "A".
null
null
null
null
can have different meanings:
null
NullReferenceException
null
null
int? a = null;
a
if (a.HasValue) {...}
if (a==null) {...}
a
a.Value
a
a.Value
InvalidOperationException
NullReferenceException
a
null
int b;
if (a.HasValue) { b = a.Value; }
if (a != null) { b = a; }
The rest of this article goes into more detail and shows mistakes that many programmers often make which can lead to a NullReferenceException
.
NullReferenceException
The runtime throwing a NullReferenceException
always means the same thing: you are trying to use a reference, and the reference is not initialized (or it was once initialized, but is no longer initialized).
NullReferenceException
This means the reference is null
, and you cannot access members (such as methods) through a null
reference. The simplest case:
null
null
string foo = null;
foo.ToUpper();
This will throw a NullReferenceException
at the second line because you can't call the instance method ToUpper()
on a string
reference pointing to null
.
NullReferenceException
ToUpper()
string
null
Debugging
How do you find the source of a NullReferenceException
? Apart from looking at the exception itself, which will be thrown exactly at the location where it occurs, the general rules of debugging in Visual Studio apply: place strategic breakpoints and inspect your variables, either by hovering the mouse over their names, opening a (Quick)Watch window or using the various debugging panels like Locals and Autos.
NullReferenceException
If you want to find out where the reference is or isn't set, right-click its name and select "Find All References". You can then place a breakpoint at every found location and run your program with the debugger attached. Every time the debugger breaks on such a breakpoint, you need to determine whether you expect the reference to be non-null, inspect the variable and and verify that it points to an instance when you expect it to.
By following the program flow this way, you can find the location where the instance should not be null, and why it isn't properly set.
Examples
Some common scenarios where the exception can be thrown:
ref1.ref2.ref3.member
If ref1 or ref2 or ref3 is null, then you'll get a NullReferenceException
. If you want to solve the problem, then find out which one is null by rewriting the expression to its simpler equivalent:
NullReferenceException
var r1 = ref1;
var r2 = r1.ref2;
var r3 = r2.ref3;
r3.member
Specifically, in HttpContext.Current.User.Identity.Name
, the HttpContext.Current
could be null, or the User
property could be null, or the Identity
property could be null.
HttpContext.Current.User.Identity.Name
HttpContext.Current
User
Identity
public class Person {
public int Age { get; set; }
}
public class Book {
public Person Author { get; set; }
}
public class Example {
public void Foo() {
Book b1 = new Book();
int authorAge = b1.Author.Age; // You never initialized the Author property.
// there is no Person to get an Age from.
}
}
If you want to avoid the child (Person) null reference, you could initialize it in the parent (Book) object's constructor.
The same applies to nested object initializers:
Book b1 = new Book { Author = { Age = 45 } };
This translates to
Book b1 = new Book();
b1.Author.Age = 45;
While the new
keyword is used, it only creates a new instance of Book
, but not a new instance of Person
, so the Author
the property is still null
.
new
Book
Person
Author
null
public class Person {
public ICollection<Book> Books { get; set; }
}
public class Book {
public string Title { get; set; }
}
The nested collection initializers behave the same:
Person p1 = new Person {
Books = {
new Book { Title = "Title1" },
new Book { Title = "Title2" },
}
};
This translates to
Person p1 = new Person();
p1.Books.Add(new Book { Title = "Title1" });
p1.Books.Add(new Book { Title = "Title2" });
The new Person
only creates an instance of Person
, but the Books
collection is still null
. The collection initializer syntax does not create a collection
for p1.Books
, it only translates to the p1.Books.Add(...)
statements.
new Person
Person
Books
null
p1.Books
p1.Books.Add(...)
int numbers = null;
int n = numbers[0]; // numbers is null. There is no array to index.
Person people = new Person[5];
people[0].Age = 20 // people[0] is null. The array was allocated but not
// initialized. There is no Person to set the Age for.
long array = new long[1];
array[0][0] = 3; // is null because only the first dimension is yet initialized.
// Use array[0] = new long[2]; first.
Dictionary<string, int> agesForNames = null;
int age = agesForNames["Bob"]; // agesForNames is null.
// There is no Dictionary to perform the lookup.
public class Person {
public string Name { get; set; }
}
var people = new List<Person>();
people.Add(null);
var names = from p in people select p.Name;
string firstName = names.First(); // Exception is thrown here, but actually occurs
// on the line above. "p" is null because the
// first element we added to the list is null.
public class Demo
{
public event EventHandler StateChanged;
protected virtual void OnStateChanged(EventArgs e)
{
StateChanged(this, e); // Exception is thrown here
// if no event handlers have been attached
// to StateChanged event
}
}
If you named fields differently from locals, you might have realized that you never initialized the field.
public class Form1 {
private Customer customer;
private void Form1_Load(object sender, EventArgs e) {
Customer customer = new Customer();
customer.Name = "John";
}
private void Button_Click(object sender, EventArgs e) {
MessageBox.Show(customer.Name);
}
}
This can be solved by following the convention to prefix fields with an underscore:
private Customer _customer;
public partial class Issues_Edit : System.Web.UI.Page
{
protected TestIssue myIssue;
protected void Page_Load(object sender, EventArgs e)
{
if (!IsPostBack)
{
// Only called on first load, not when button clicked
myIssue = new TestIssue();
}
}
protected void SaveButton_Click(object sender, EventArgs e)
{
myIssue.Entry = "NullReferenceException here!";
}
}
// if the "FirstName" session value has not yet been set,
// then this line will throw a NullReferenceException
string firstName = Session["FirstName"].ToString();
If the exception occurs when referencing a property of @Model
in an ASP.NET MVC view, you need to understand that the Model
gets set in your action method, when you return
a view. When you return an empty model (or model property) from your controller, the exception occurs when the views access it:
@Model
Model
return
// Controller
public class Restaurant:Controller
{
public ActionResult Search()
{
return View(); // Forgot the provide a Model here.
}
}
// Razor view
@foreach (var restaurantSearch in Model.RestaurantSearch) // Throws.
{
}
<p>@Model.somePropertyName</p> <!-- Also throws -->
WPF controls are created during the call to InitializeComponent
in the order they appear in the visual tree. A NullReferenceException
will be raised in the case of early-created controls with event handlers, etc. , that fire during InitializeComponent
which reference late-created controls.
InitializeComponent
NullReferenceException
InitializeComponent
For example :
<Grid>
<!-- Combobox declared first -->
<ComboBox Name="comboBox1"
Margin="10"
SelectedIndex="0"
SelectionChanged="comboBox1_SelectionChanged">
<ComboBoxItem Content="Item 1" />
<ComboBoxItem Content="Item 2" />
<ComboBoxItem Content="Item 3" />
</ComboBox>
<!-- Label declared later -->
<Label Name="label1"
Content="Label"
Margin="10" />
</Grid>
Here comboBox1
is created before label1
. If comboBox1_SelectionChanged
attempts to reference `label1, it will not yet have been created.
comboBox1
label1
comboBox1_SelectionChanged
private void comboBox1_SelectionChanged(object sender, SelectionChangedEventArgs e)
{
label1.Content = comboBox1.SelectedIndex.ToString(); // NullReference here!!
}
Changing the order of the declarations in the XAML (i.e., listing label1
before comboBox1
, ignoring issues of design philosophy, would at least resolve the NullReferenceException
here.
label1
comboBox1
NullReferenceException
as
var myThing = someObject as Thing;
This doesn't throw an InvalidCastException but returns a null
when the cast fails (and when someObject is itself null). So be aware of that.
null
The plain versions First()
and Single()
throw exceptions when there is nothing. The "OrDefault" versions return null in that case. So be aware of that.
First()
Single()
foreach
throws when you try to iterate null collection. Usually caused by unexpected null
result from methods that return collections.
foreach
null
List<int> list = null;
foreach(var v in list) { } // exception
More realistic example - select nodes from XML document. Will throw if nodes are not found but initial debugging shows that all properties valid:
foreach (var node in myData.MyXml.DocumentNode.SelectNodes("//Data"))
Ways to Avoid
null
If you expect the reference sometimes to be null, you can check for it being null
before accessing instance members:
null
void PrintName(Person p) {
if (p != null) {
Console.WriteLine(p.Name);
}
}
null
Methods call you expect to return an instance can return null
, for example when the object being sought cannot be found. You can choose to return a default value when this is the case:
null
string GetCategory(Book b) {
if (b == null)
return "Unknown";
return b.Category;
}
null
You can also throw a custom exception, only to catch it in the calling code:
string GetCategory(string bookTitle) {
var book = library.FindBook(bookTitle); // This may return null
if (book == null)
throw new BookNotFoundException(bookTitle); // Your custom exception
return book.Category;
}
Debug.Assert
null
When you know during development that a method maybe can, but never should return null
, you can use Debug.Assert()
to break as soon as possible when it does occur:
null
Debug.Assert()
string GetTitle(int knownBookID) {
// You know this should never return null.
var book = library.GetBook(knownBookID);
// Exception will occur on the next line instead of at the end of this method.
Debug.Assert(book != null, "Library didn't return a book for known book ID.");
// Some other code
return book.Title; // Will never throw NullReferenceException in Debug mode.
}
Though this check will not end up in your release build, causing it to throw the NullReferenceException
again when book == null
at runtime in release mode.
NullReferenceException
book == null
GetValueOrDefault()
null
DateTime? appointment = null;
Console.WriteLine(appointment.GetValueOrDefault(DateTime.Now));
// Will display the default value provided (DateTime.Now), because appointment is null.
appointment = new DateTime(2022, 10, 20);
Console.WriteLine(appointment.GetValueOrDefault(DateTime.Now));
// Will display the appointment date, not the default
??
If()
The shorthand to providing a default value when a null
is encountered:
null
IService CreateService(ILogger log, Int32? frobPowerLevel)
{
var serviceImpl = new MyService(log ?? NullLog.Instance);
// Note that the above "GetValueOrDefault()" can also be rewritten to use
// the coalesce operator:
serviceImpl.FrobPowerLevel = frobPowerLevel ?? 5;
}
?.
?[x]
This is also sometimes called the safe navigation or Elvis (after its shape) operator. If the expression on the left side of the operator is null, then the right side will not be evaluated, and null is returned instead. That means cases like this:
var title = person.Title.ToUpper();
If the person does not have a title, this will throw an exception because it is trying to call ToUpper
on a property with a null value.
ToUpper
In C# 5 and below, this can be guarded with:
var title = person.Title == null ? null : person.Title.ToUpper();
Now the title variable will be null instead of throwing an exception. C# 6 introduces a shorter syntax for this:
var title = person.Title?.ToUpper();
This will result in the title variable being null
, and the call to ToUpper
is not made if person.Title
is null
.
null
ToUpper
person.Title
null
Of course, you still have to check title
for null or use the null condition operator together with the null coalescing operator (??
) to supply a default value:
title
??
// regular null check
int titleLength = 0;
if (title != null)
titleLength = title.Length; // If title is null, this would throw NullReferenceException
// combining the `?` and the `??` operator
int titleLength = title?.Length ?? 0;
Likewise, for arrays you can use ?[i]
as follows:
?[i]
int myIntArray=null;
var i=5;
int? elem = myIntArray?[i];
if (!elem.HasValue) Console.WriteLine("No value");
This will do the following: If myIntArray is null, the expression returns null and you can safely check it. If it contains an array, it will do the same as:elem = myIntArray[i];
and returns the ith element.
elem = myIntArray[i];
C# supports "iterator blocks" (called "generators" in some other popular languages). Null dereference exceptions can be particularly tricky to debug in iterator blocks because of deferred execution:
public IEnumerable<Frob> GetFrobs(FrobFactory f, int count)
{
for (int i = 0; i < count; ++i)
yield return f.MakeFrob();
}
...
FrobFactory factory = whatever;
IEnumerable<Frobs> frobs = GetFrobs();
...
foreach(Frob frob in frobs) { ... }
If whatever
results in null
then MakeFrob
will throw. Now, you might think that the right thing to do is this:
whatever
null
MakeFrob
// DON'T DO THIS
public IEnumerable<Frob> GetFrobs(FrobFactory f, int count)
{
if (f == null)
throw new ArgumentNullException("f", "factory must not be null");
for (int i = 0; i < count; ++i)
yield return f.MakeFrob();
}
Why is this wrong? Because the iterator block does not actually run until the foreach
! The call to GetFrobs
simply returns an object which when iterated will run the iterator block.
foreach
GetFrobs
By writing a null check like this you prevent the null dereference, but you move the null argument exception to the point of the iteration, not to the point of the call, and that is very confusing to debug.
The correct fix is:
// DO THIS
public IEnumerable<Frob> GetFrobs(FrobFactory f, int count)
{
// No yields in a public method that throws!
if (f == null)
throw new ArgumentNullException("f", "factory must not be null");
return GetFrobsForReal(f, count);
}
private IEnumerable<Frob> GetFrobsForReal(FrobFactory f, int count)
{
// Yields in a private method
Debug.Assert(f != null);
for (int i = 0; i < count; ++i)
yield return f.MakeFrob();
}
That is, make a private helper method that has the iterator block logic, and a public surface method that does the null check and returns the iterator. Now when GetFrobs
is called, the null check happens immediately, and then GetFrobsForReal
executes when the sequence is iterated.
GetFrobs
GetFrobsForReal
If you examine the reference source for LINQ to Objects you will see that this technique is used throughout. It is slightly more clunky to write, but it makes debugging nullity errors much easier. Optimize your code for the convenience of the caller, not the convenience of the author.
C# has an "unsafe" mode which is, as the name implies, extremely dangerous because the normal safety mechanisms which provide memory safety and type safety are not enforced. You should not be writing unsafe code unless you have a thorough and deep understanding of how memory works.
In unsafe mode, you should be aware of two important facts:
To understand why that is, it helps to understand how .NET produces null dereference exceptions in the first place. (These details apply to .NET running on Windows; other operating systems use similar mechanisms.)
Memory is virtualized in Windows; each process gets a virtual memory space of many "pages" of memory that are tracked by the operating system. Each page of memory has flags set on it which determine how it may be used: read from, written to, executed, and so on. The lowest page is marked as "produce an error if ever used in any way".
Both a null pointer and a null reference in C# are internally represented as the number zero, and so any attempt to dereference it into its corresponding memory storage causes the operating system to produce an error. The .NET runtime then detects this error and turns it into the null dereference exception.
That's why dereferencing both a null pointer and a null reference produces the same exception.
What about the second point? Dereferencing any invalid pointer that falls in the lowest page of virtual memory causes the same operating system error, and thereby the same exception.
Why does this make sense? Well, suppose we have a struct containing two ints, and an unmanaged pointer equal to null. If we attempt to dereference the second int in the struct, the CLR will not attempt to access the storage at location zero; it will access the storage at location four. But logically this is a null dereference because we are getting to that address via the null.
If you are working with unsafe code and you get a null dereference exception, just be aware that the offending pointer need not be null. It can be any location in the lowest page, and this exception will be produced.
Maybe this is a dumb comment but wouldnt the first and best way to avoid this problem be to initialize the object? For me if this error occurs it is usually because I forgot to initialize something like the array element. I think it is far less common to define the object as null and then reference it. Maybe give the way to solve each problem adjacent to the description. Still a good post.
– JPK
May 20 '14 at 6:39
What if there is no object, but rather the return value from a method or property?
– John Saunders
May 20 '14 at 6:41
The book/author example is a little weird.... How does that even compile? How does intellisense even work? What is this I'm not good with computar...
– Will
Sep 8 '14 at 18:26
@Will: does my last edit help? If not, then please be more explicit about what you see as a problem.
– John Saunders
Sep 8 '14 at 18:41
@JohnSaunders Oh, no, sorry, I meant the object initializer version of that.
new Book { Author = { Age = 45 } };
How does the inner initialization even... I can't think of a situation where inner init would ever work, yet it compiles and intellisense works... Unless for structs?– Will
Sep 8 '14 at 18:44
new Book { Author = { Age = 45 } };
NullReference Exception — Visual Basic
The NullReference Exception
for Visual Basic is no different from the one in C#. After all, they are both reporting the same exception defined in the .NET Framework which they both use. Causes unique to Visual Basic are rare (perhaps only one).
NullReference Exception
This answer will use Visual Basic terms, syntax, and context. The examples used come from a large number of past Stack Overflow questions. This is to maximize relevance by using the kinds of situations often seen in posts. A bit more explanation is also provided for those who might need it. An example similar to yours is very likely listed here.
Note:
NullReferenceException
The message "Object not set to an instance of Object" means you are trying to use an object which has not been initialized. This boils down to one of these:
Since the problem is an object reference which is Nothing
, the answer is to examine them to find out which one. Then determine why it is not initialized. Hold the mouse over the various variables and Visual Studio (VS) will show their values - the culprit will be Nothing
.
Nothing
Nothing
You should also remove any Try/Catch blocks from the relevant code, especially ones where there is nothing in the Catch block. This will cause your code to crash when it tries to use an object which is Nothing
. This is what you want because it will identify the exact location of the problem, and allow you to identify the object causing it.
Nothing
A MsgBox
in the Catch which displays Error while...
will be of little help. This method also leads to very bad Stack Overflow questions, because you can't describe the actual exception, the object involved or even the line of code where it happens.
MsgBox
Error while...
You can also use the Locals Window
(Debug -> Windows -> Locals) to examine your objects.
Locals Window
Once you know what and where the problem is, it is usually fairly easy to fix and faster than posting a new question.
See also:
Dim reg As CashRegister
...
TextBox1.Text = reg.Amount ' NRE
The problem is that Dim
does not create a CashRegister object; it only declares a variable named reg
of that Type. Declaring an object variable and creating an instance are two different things.
Dim
reg
Remedy
The New
operator can often be used to create the instance when you declare it:
New
Dim reg As New CashRegister ' [New] creates instance, invokes the constructor
' Longer, more explicit form:
Dim reg As CashRegister = New CashRegister
When it is only appropriate to create the instance later:
Private reg As CashRegister ' Declare
...
reg = New CashRegister() ' Create instance
Note: Do not use Dim
again in a procedure, including the constructor (Sub New
):
Dim
Sub New
Private reg As CashRegister
'...
Public Sub New()
'...
Dim reg As New CashRegister
End Sub
This will create a local variable, reg
, which exists only in that context (sub). The reg
variable with module level Scope
which you will use everywhere else remains Nothing
.
reg
reg
Scope
Nothing
Missing the New
operator is the #1 cause of NullReference Exceptions
seen in the Stack Overflow questions reviewed.
New
NullReference Exceptions
Visual Basic tries to make the process clear repeatedly using New
: Using the New
Operator creates a new object and calls Sub New
-- the constructor -- where your object can perform any other initialization.
New
New
Sub New
To be clear, Dim
(or Private
) only declares a variable and its Type
. The Scope of the variable - whether it exists for the entire module/class or is local to a procedure - is determined by where it is declared. Private | Friend | Public
defines the access level, not Scope.
Dim
Private
Type
Private | Friend | Public
For more information, see:
Arrays must also be instantiated:
Private arr as String()
This array has only been declared, not created. There are several ways to initialize an array:
Private arr as String() = New String(10){}
' or
Private arr() As String = New String(10){}
' For a local array (in a procedure) and using 'Option Infer':
Dim arr = New String(10) {}
Note: Beginning with VS 2010, when initializing a local array using a literal and Option Infer
, the As <Type>
and New
elements are optional:
Option Infer
As <Type>
New
Dim myDbl As Double() = {1.5, 2, 9.9, 18, 3.14}
Dim myDbl = New Double() {1.5, 2, 9.9, 18, 3.14}
Dim myDbl() = {1.5, 2, 9.9, 18, 3.14}
The data Type and array size are inferred from the data being assigned. Class/Module level declarations still require As <Type>
with Option Strict
:
As <Type>
Option Strict
Private myDoubles As Double() = {1.5, 2, 9.9, 18, 3.14}
Example: Array of class objects
Dim arrFoo(5) As Foo
For i As Integer = 0 To arrFoo.Count - 1
arrFoo(i).Bar = i * 10 ' Exception
Next
The array has been created, but the Foo
objects in it have not.
Foo
Remedy
For i As Integer = 0 To arrFoo.Count - 1
arrFoo(i) = New Foo() ' Create Foo instance
arrFoo(i).Bar = i * 10
Next
Using a List(Of T)
will make it quite difficult to have an element without a valid object:
List(Of T)
Dim FooList As New List(Of Foo) ' List created, but it is empty
Dim f As Foo ' Temporary variable for the loop
For i As Integer = 0 To 5
f = New Foo() ' Foo instance created
f.Bar = i * 10
FooList.Add(f) ' Foo object added to list
Next
For more information, see:
.NET collections (of which there are many varieties - Lists, Dictionary, etc.) must also be instantiated or created.
Private myList As List(Of String)
..
myList.Add("ziggy") ' NullReference
You get the same exception for the same reason - myList
was only declared, but no instance created. The remedy is the same:
myList
myList = New List(Of String)
' Or create an instance when declared:
Private myList As New List(Of String)
A common oversight is a class which uses a collection Type
:
Type
Public Class Foo
Private barList As List(Of Bar)
Friend Function BarCount As Integer
Return barList.Count
End Function
Friend Sub AddItem(newBar As Bar)
If barList.Contains(newBar) = False Then
barList.Add(newBar)
End If
End Function
Either procedure will result in an NRE, because barList
is only declared, not instantiated. Creating an instance of Foo
will not also create an instance of the internal barList
. It may have been the intent to do this in the constructor:
barList
Foo
barList
Public Sub New ' Constructor
' Stuff to do when a new Foo is created...
barList = New List(Of Bar)
End Sub
As before, this is incorrect:
Public Sub New()
' Creates another barList local to this procedure
Dim barList As New List(Of Bar)
End Sub
For more information, see List(Of T)
Class.
List(Of T)
Working with databases presents many opportunities for a NullReference because there can be many objects (Command
, Connection
, Transaction
, Dataset
, DataTable
, DataRows
....) in use at once. Note: It does not matter which data provider you are using -- MySQL, SQL Server, OleDB, etc. -- the concepts are the same.
Command
Connection
Transaction
Dataset
DataTable
DataRows
Example 1
Dim da As OleDbDataAdapter
Dim ds As DataSet
Dim MaxRows As Integer
con.Open()
Dim sql = "SELECT * FROM tblfoobar_List"
da = New OleDbDataAdapter(sql, con)
da.Fill(ds, "foobar")
con.Close()
MaxRows = ds.Tables("foobar").Rows.Count ' Error
As before, the ds
Dataset object was declared, but an instance was never created. The DataAdapter
will fill an existing DataSet
, not create one. In this case, since ds
is a local variable, the IDE warns you that this might happen:
ds
DataAdapter
DataSet
ds
When declared as a module/class level variable, as appears to be the case with con
, the compiler can't know if the object was created by an upstream procedure. Do not ignore warnings.
con
Remedy
Dim ds As New DataSet
Example 2
ds = New DataSet
da = New OleDBDataAdapter(sql, con)
da.Fill(ds, "Employees")
txtID.Text = ds.Tables("Employee").Rows(0).Item(1)
txtID.Name = ds.Tables("Employee").Rows(0).Item(2)
A typo is a problem here: Employees
vs Employee
. There was no DataTable
named "Employee" created, so a NullReferenceException
results trying to access it. Another potential problem is assuming there will be Items
which may not be so when the SQL includes a WHERE clause.
Employees
Employee
DataTable
NullReferenceException
Items
Remedy
Since this uses one table, using Tables(0)
will avoid spelling errors. Examining Rows.Count
can also help:
Tables(0)
Rows.Count
If ds.Tables(0).Rows.Count > 0 Then
txtID.Text = ds.Tables(0).Rows(0).Item(1)
txtID.Name = ds.Tables(0).Rows(0).Item(2)
End If
Fill
is a function returning the number of Rows
affected which can also be tested:
Fill
Rows
If da.Fill(ds, "Employees") > 0 Then...
Example 3
Dim da As New OleDb.OleDbDataAdapter("SELECT TICKET.TICKET_NO,
TICKET.CUSTOMER_ID, ... FROM TICKET_RESERVATION AS TICKET INNER JOIN
FLIGHT_DETAILS AS FLIGHT ... WHERE [TICKET.TICKET_NO]= ...", con)
Dim ds As New DataSet
da.Fill(ds)
If ds.Tables("TICKET_RESERVATION").Rows.Count > 0 Then
The DataAdapter
will provide TableNames
as shown in the previous example, but it does not parse names from the SQL or database table. As a result, ds.Tables("TICKET_RESERVATION")
references a non-existent table.
DataAdapter
TableNames
ds.Tables("TICKET_RESERVATION")
The Remedy is the same, reference the table by index:
If ds.Tables(0).Rows.Count > 0 Then
See also DataTable Class.
If myFoo.Bar.Items IsNot Nothing Then
...
The code is only testing Items
while both myFoo
and Bar
may also be Nothing. The remedy is to test the entire chain or path of objects one at a time:
Items
myFoo
Bar
If (myFoo IsNot Nothing) AndAlso
(myFoo.Bar IsNot Nothing) AndAlso
(myFoo.Bar.Items IsNot Nothing) Then
....
AndAlso
is important. Subsequent tests will not be performed once the first False
condition is encountered. This allows the code to safely 'drill' into the object(s) one 'level' at a time, evaluating myFoo.Bar
only after (and if) myFoo
is determined to be valid. Object chains or paths can get quite long when coding complex objects:
AndAlso
False
myFoo.Bar
myFoo
myBase.myNodes(3).Layer.SubLayer.Foo.Files.Add("somefilename")
It is not possible to reference anything 'downstream' of a null
object. This also applies to controls:
null
myWebBrowser.Document.GetElementById("formfld1").InnerText = "some value"
Here, myWebBrowser
or Document
could be Nothing or the formfld1
element may not exist.
myWebBrowser
Document
formfld1
Dim cmd5 As New SqlCommand("select Cartons, Pieces, Foobar " _
& "FROM Invoice where invoice_no = '" & _
Me.ComboBox5.SelectedItem.ToString.Trim & "' And category = '" & _
Me.ListBox1.SelectedItem.ToString.Trim & "' And item_name = '" & _
Me.ComboBox2.SelectedValue.ToString.Trim & "' And expiry_date = '" & _
Me.expiry.Text & "'", con)
Among other things, this code does not anticipate that the user may not have selected something in one or more UI controls. ListBox1.SelectedItem
may well be Nothing
, so ListBox1.SelectedItem.ToString
will result in an NRE.
ListBox1.SelectedItem
Nothing
ListBox1.SelectedItem.ToString
Remedy
Validate data before using it (also use Option Strict
and SQL parameters):
Option Strict
Dim expiry As DateTime ' for text date validation
If (ComboBox5.SelectedItems.Count > 0) AndAlso
(ListBox1.SelectedItems.Count > 0) AndAlso
(ComboBox2.SelectedItems.Count > 0) AndAlso
(DateTime.TryParse(expiry.Text, expiry) Then
'... do stuff
Else
MessageBox.Show(...error message...)
End If
Alternatively, you can use (ComboBox5.SelectedItem IsNot Nothing) AndAlso...
(ComboBox5.SelectedItem IsNot Nothing) AndAlso...
Public Class Form1
Private NameBoxes = New TextBox(5) {Controls("TextBox1"), _
Controls("TextBox2"), Controls("TextBox3"), _
Controls("TextBox4"), Controls("TextBox5"), _
Controls("TextBox6")}
' same thing in a different format:
Private boxList As New List(Of TextBox) From {TextBox1, TextBox2, TextBox3 ...}
' Immediate NRE:
Private somevar As String = Me.Controls("TextBox1").Text
This is a fairly common way to get an NRE. In C#, depending on how it is coded, the IDE will report that Controls
does not exist in the current context, or "cannot reference non-static member". So, to some extent, this is a VB-only situation. It is also complex because it can result in a failure cascade.
Controls
The arrays and collections cannot be initialized this way. This initialization code will run before the constructor creates the Form
or the Controls
. As a result:
Form
Controls
somevar
.Text
Referencing array elements later will result in an NRE. If you do this in Form_Load
, due to an odd bug, the IDE may not report the exception when it happens. The exception will pop up later when your code tries to use the array. This "silent exception" is detailed in this post. For our purposes, the key is that when something catastrophic happens while creating a form (Sub New
or Form Load
event), exceptions may go unreported, the code exits the procedure and just displays the form.
Form_Load
Sub New
Form Load
Since no other code in your Sub New
or Form Load
event will run after the NRE, a great many other things can be left uninitialized.
Sub New
Form Load
Sub Form_Load(..._
'...
Dim name As String = NameBoxes(2).Text ' NRE
' ...
' More code (which will likely not be executed)
' ...
End Sub
Note this applies to any and all control and component references making these illegal where they are:
Public Class Form1
Private myFiles() As String = Me.OpenFileDialog1.FileName & ...
Private dbcon As String = OpenFileDialog1.FileName & ";Jet Oledb..."
Private studentName As String = TextBox13.Text
Partial Remedy
It is curious that VB does not provide a warning, but the remedy is to declare the containers at the form level, but initialize them in form load event handler when the controls do exist. This can be done in Sub New
as long as your code is after the InitializeComponent
call:
Sub New
InitializeComponent
' Module level declaration
Private NameBoxes as TextBox()
Private studentName As String
' Form Load, Form Shown or Sub New:
'
' Using the OP's approach (illegal using OPTION STRICT)
NameBoxes = New TextBox() {Me.Controls("TextBox1"), Me.Controls("TestBox2"), ...)
studentName = TextBox32.Text ' For simple control references
The array code may not be out of the woods yet. Any controls which are in a container control (like a GroupBox
or Panel
) will not be found in Me.Controls
; they will be in the Controls collection of that Panel or GroupBox. Nor will a control be returned when the control name is misspelled ("TeStBox2"
). In such cases, Nothing
will again be stored in those array elements and an NRE will result when you attempt to reference it.
GroupBox
Panel
Me.Controls
"TeStBox2"
Nothing
These should be easy to find now that you know what you are looking for:
"Button2" resides on a Panel
Panel
Remedy
Rather than indirect references by name using the form's Controls
collection, use the control reference:
Controls
' Declaration
Private NameBoxes As TextBox()
' Initialization - simple and easy to read, hard to botch:
NameBoxes = New TextBox() {TextBox1, TextBox2, ...)
' Initialize a List
NamesList = New List(Of TextBox)({TextBox1, TextBox2, TextBox3...})
' or
NamesList = New List(Of TextBox)
NamesList.AddRange({TextBox1, TextBox2, TextBox3...})
Private bars As New List(Of Bars) ' Declared and created
Public Function BarList() As List(Of Bars)
bars.Clear
If someCondition Then
For n As Integer = 0 to someValue
bars.Add(GetBar(n))
Next n
Else
Exit Function
End If
Return bars
End Function
This is a case where the IDE will warn you that 'not all paths return a value and a NullReferenceException
may result'. You can suppress the warning, by replacing Exit Function
with Return Nothing
, but that does not solve the problem. Anything which tries to use the return when someCondition = False
will result in an NRE:
NullReferenceException
Exit Function
Return Nothing
someCondition = False
bList = myFoo.BarList()
For Each b As Bar in bList ' EXCEPTION
...
Remedy
Replace Exit Function
in the function with Return bList
. Returning an empty List
is not the same as returning Nothing
. If there is a chance that a returned object can be Nothing
, test before using it:
Exit Function
Return bList
List
Nothing
Nothing
bList = myFoo.BarList()
If bList IsNot Nothing Then...
A badly implemented Try/Catch can hide where the problem is and result in new ones:
Dim dr As SqlDataReader
Try
Dim lnk As LinkButton = TryCast(sender, LinkButton)
Dim gr As GridViewRow = DirectCast(lnk.NamingContainer, GridViewRow)
Dim eid As String = GridView1.DataKeys(gr.RowIndex).Value.ToString()
ViewState("username") = eid
sqlQry = "select FirstName, Surname, DepartmentName, ExtensionName, jobTitle,
Pager, mailaddress, from employees1 where username='" & eid & "'"
If connection.State <> ConnectionState.Open Then
connection.Open()
End If
command = New SqlCommand(sqlQry, connection)
'More code fooing and barring
dr = command.ExecuteReader()
If dr.Read() Then
lblFirstName.Text = Convert.ToString(dr("FirstName"))
...
End If
mpe.Show()
Catch
Finally
command.Dispose()
dr.Close() ' <-- NRE
connection.Close()
End Try
This is a case of an object not being created as expected, but also demonstrates the counter usefulness of an empty Catch
.
Catch
There is an extra comma in the SQL (after 'mailaddress') which results in an exception at .ExecuteReader
. After the Catch
does nothing, Finally
tries to perform clean up, but since you cannot Close
a null DataReader
object, a brand new NullReferenceException
results.
.ExecuteReader
Catch
Finally
Close
DataReader
NullReferenceException
An empty Catch
block is the devil's playground. This OP was baffled why he was getting an NRE in the Finally
block. In other situations, an empty Catch
may result in something else much further downstream going haywire and cause you to spend time looking at the wrong things in the wrong place for the problem. (The "silent exception" described above provides the same entertainment value.)
Catch
Finally
Catch
Remedy
Don't use empty Try/Catch blocks - let the code crash so you can a) identify the cause b) identify the location and c) apply a proper remedy. Try/Catch blocks are not intended to hide exceptions from the person uniquely qualified to fix them - the developer.
For Each row As DataGridViewRow In dgvPlanning.Rows
If Not IsDBNull(row.Cells(0).Value) Then
...
The IsDBNull
function is used to test if a value equals System.DBNull
: From MSDN:
IsDBNull
System.DBNull
The System.DBNull value indicates that the Object represents missing or non-existent data. DBNull is not the same as Nothing, which indicates that a variable has not yet been initialized.
Remedy
If row.Cells(0) IsNot Nothing Then ...
As before, you can test for Nothing, then for a specific value:
If (row.Cells(0) IsNot Nothing) AndAlso (IsDBNull(row.Cells(0).Value) = False) Then
Example 2
Dim getFoo = (From f In dbContext.FooBars
Where f.something = something
Select f).FirstOrDefault
If Not IsDBNull(getFoo) Then
If IsDBNull(getFoo.user_id) Then
txtFirst.Text = getFoo.first_name
Else
...
FirstOrDefault
returns the first item or the default value, which is Nothing
for reference types and never DBNull
:
FirstOrDefault
Nothing
DBNull
If getFoo IsNot Nothing Then...
Dim chk As CheckBox
chk = CType(Me.Controls(chkName), CheckBox)
If chk.Checked Then
Return chk
End If
If a CheckBox
with chkName
can't be found (or exists in a GroupBox
), then chk
will be Nothing and be attempting to reference any property will result in an exception.
CheckBox
chkName
GroupBox
chk
Remedy
If (chk IsNot Nothing) AndAlso (chk.Checked) Then ...
The DGV has a few quirks seen periodically:
dgvBooks.DataSource = loan.Books
dgvBooks.Columns("ISBN").Visible = True ' NullReferenceException
dgvBooks.Columns("Title").DefaultCellStyle.Format = "C"
dgvBooks.Columns("Author").DefaultCellStyle.Format = "C"
dgvBooks.Columns("Price").DefaultCellStyle.Format = "C"
If dgvBooks
has AutoGenerateColumns = True
, it will create the columns, but it does not name them, so the above code fails when it references them by name.
dgvBooks
AutoGenerateColumns = True
Remedy
Name the columns manually, or reference by index:
dgvBooks.Columns(0).Visible = True
xlWorkSheet = xlWorkBook.Sheets("sheet1")
For i = 0 To myDGV.RowCount - 1
For j = 0 To myDGV.ColumnCount - 1
For k As Integer = 1 To myDGV.Columns.Count
xlWorkSheet.Cells(1, k) = myDGV.Columns(k - 1).HeaderText
xlWorkSheet.Cells(i + 2, j + 1) = myDGV(j, i).Value.ToString()
Next
Next
Next
When your DataGridView
has AllowUserToAddRows
as True
(the default), the Cells
in the blank/new row at the bottom will all contain Nothing
. Most attempts to use the contents (for example, ToString
) will result in an NRE.
DataGridView
AllowUserToAddRows
True
Cells
Nothing
ToString
Remedy
Use a For/Each
loop and test the IsNewRow
property to determine if it is that last row. This works whether AllowUserToAddRows
is true or not:
For/Each
IsNewRow
AllowUserToAddRows
For Each r As DataGridViewRow in myDGV.Rows
If r.IsNewRow = False Then
' ok to use this row
If you do use a For n
loop, modify the row count or use Exit For
when IsNewRow
is true.
For n
Exit For
IsNewRow
Under certain circumstances, trying to use an item from My.Settings
which is a StringCollection
can result in a NullReference the first time you use it. The solution is the same, but not as obvious. Consider:
My.Settings
StringCollection
My.Settings.FooBars.Add("ziggy") ' foobars is a string collection
Since VB is managing Settings for you, it is reasonable to expect it to initialize the collection. It will, but only if you have previously added an initial entry to the collection (in the Settings editor). Since the collection is (apparently) initialized when an item is added, it remains Nothing
when there are no items in the Settings editor to add.
Nothing
Remedy
Initialize the settings collection in the form's Load
event handler, if/when needed:
Load
If My.Settings.FooBars Is Nothing Then
My.Settings.FooBars = New System.Collections.Specialized.StringCollection
End If
Typically, the Settings
collection will only need to be initialized the first time the application runs. An alternate remedy is to add an initial value to your collection in Project -> Settings | FooBars, save the project, then remove the fake value.
Settings
Key Points
You probably forgot the New
operator.
New
or
Something you assumed would perform flawlessly to return an initialized object to your code, did not.
Don't ignore compiler warnings (ever) and use Option Strict On
(always).
Option Strict On
MSDN NullReference Exception
Another scenario is when you cast a null object into a value type. For example, the code below:
object o = null;
DateTime d = (DateTime)o;
It will throw a NullReferenceException
on the cast. It seems quite obvious in the above sample, but this can happen in more "late-binding" intricate scenarios where the null object has been returned from some code you don't own, and the cast is for example generated by some automatic system.
NullReferenceException
One example of this is this simple ASP.NET binding fragment with the Calendar control:
<asp:Calendar runat="server" SelectedDate="<%#Bind("Something")%>" />
Here, SelectedDate
is in fact a property - of DateTime
type - of the Calendar
Web Control type, and the binding could perfectly return something null. The implicit ASP.NET Generator will create a piece of code that will be equivalent to the cast code above. And this will raise a NullReferenceException
that is quite difficult to spot, because it lies in ASP.NET generated code which compiles fine...
SelectedDate
DateTime
Calendar
NullReferenceException
Great catch. One-liner way to avoid:
DateTime x = (DateTime) o as DateTime? ?? defaultValue;
– Serge Shultz
Jun 29 '15 at 11:07
DateTime x = (DateTime) o as DateTime? ?? defaultValue;
It means that the variable in question is pointed at nothing. I could generate this like so:
SqlConnection connection = null;
connection.Open();
That will throw the error because while I've declared the variable "connection
", it's not pointed to anything. When I try to call the member "Open
", there's no reference for it to resolve, and it will throw the error.
connection
Open
To avoid this error:
object == null
JetBrains' Resharper tool will identify every place in your code that has the possibility of a null reference error, allowing you to put in a null check. This error is the number one source of bugs, IMHO.
JetBrains' Resharper tool will identify every place in your code that has the possibility of a null reference error. This is incorrect. I have a solution without that detection, yet the code occasionally results to the exception. I suspect it's occasionally undetectable - by them at least - when multithreading is involved, but I can't comment further because I didn't identify the location of my bug yet.
– j riv
Jan 21 at 7:42
But how to solve it when the NullReferenceException comes in usign HttpContext.Current.Responce.Clear(). It is not getting solved by any of the above solution. because while creating its object object of HttpContext then a error comes "Overload resolution failed because no accessible 'New' accepts this Number of arguments.
– Sunny Sandeep
Feb 2 at 11:14
It means your code used an object reference variable that was set to null (i.e. it did not reference an actual object instance).
To prevent the error, objects that could be null should be tested for null before being used.
if (myvar != null)
{
// Go ahead and use myvar
myvar.property = ...
}
else
{
// Whoops! myvar is null and cannot be used without first
// assigning it to an instance reference
// Attempting to use myvar here will result in NullReferenceException
}
Be aware that regardless of the scenario, the cause is always the same in .NET:
You are trying to use a reference variable whose value is Nothing
/null
. When the value is Nothing
/null
for the reference variable, that means it is not actually holding a reference to an instance of any object that exists on the heap.
Nothing
null
Nothing
null
You either never assigned something to the variable, never created an instance of the value assigned to the variable, or you set the variable equal to Nothing
/null
manually, or you called a function that set the variable to Nothing
/null
for you.
Nothing
null
Nothing
null
An example of this exception being thrown is: When you are trying to check something, that is null.
For example:
string testString = null; //Because it doesn't have a value (i.e. it's null; "Length" cannot do what it needs to do)
if (testString.Length == 0) // Throws a nullreferenceexception
{
//Do something
}
The .NET runtime will throw a NullReferenceException when you attempt to perform an action on something which hasn't been instantiated i.e. the code above.
In comparison to an ArgumentNullException which is typically thrown as a defensive measure if a method expects that what is being passed to it is not null.
More information is in C# NullReferenceException and Null Parameter.
If you have not initialized a reference type, and you want to set or read one of its properties, it will throw a NullReferenceException.
Example:
Person p = null;
p.Name = "Harry"; // NullReferenceException occurs here.
You can simply avoid this by checking if the variable is not null:
Person p = null;
if (p!=null)
{
p.Name = "Harry"; // Not going to run to this point
}
To fully understand why a NullReferenceException is thrown, it is important to know the difference between value types and reference types.
So, if you're dealing with value types, NullReferenceExceptions can not occur. Though you need to keep alert when dealing with reference types!
Only reference types, as the name is suggesting, can hold references or point literally to nothing (or 'null'). Whereas value types always contain a value.
Reference types (these ones must be checked):
Value types (you can simply ignore these ones):
-1: since the question is "What is a NullReferenceException", value types are not relevant.
– John Saunders
May 16 '13 at 22:00
@John Saunders: I disagree. As a software developer it is really important to be able to distinguish between value and reference types. else people will end up checking if integers are null.
– Fabian Bigler
May 16 '13 at 22:28
True, just not in the context of this question.
– John Saunders
May 16 '13 at 22:44
Thanks for the hint. I improved it a bit and added an example at the top. I still think mentioning Reference & Value Types is useful.
– Fabian Bigler
May 16 '13 at 23:02
I think you haven't added anything that wasn't in the other answers, since the question pre-supposes a reference type.
– John Saunders
May 18 '13 at 23:24
Another case where NullReferenceExceptions
can happen is the (incorrect) use of the as
operator:
NullReferenceExceptions
as
class Book {
public string Name { get; set; }
}
class Car { }
Car mycar = new Car();
Book mybook = mycar as Book; // Incompatible conversion --> mybook = null
Console.WriteLine(mybook.Name); // NullReferenceException
Here, Book
and Car
are incompatible types; a Car
cannot be converted/cast to a Book
. When this cast fails, as
returns null
. Using mybook
after this causes a NullReferenceException
.
Book
Car
Car
Book
as
null
mybook
NullReferenceException
In general, you should use a cast or as
, as follows:
as
If you are expecting the type conversion to always succeed (ie. you know what the object should be ahead of time), then you should use a cast:
ComicBook cb = (ComicBook)specificBook;
If you are unsure of the type, but you want to try to use it as a specific type, then use as
:
as
ComicBook cb = specificBook as ComicBook;
if (cb != null) {
// ...
}
This can happen a lot when unboxing a variable. I find it happens often in event handlers after I changed the type of the UI element but forget to update the code-behind.
– Brendan
Feb 19 '14 at 0:24
You are using the object that contains the null value reference. So it's giving a null exception. In the example the string value is null and when checking its length, the exception occurred.
Example:
string value = null;
if (value.Length == 0) // <-- Causes exception
{
Console.WriteLine(value); // <-- Never reached
}
The exception error is:
Unhandled Exception:
System.NullReferenceException: Object reference not set to an instance
of an object. at Program.Main()
How profound! I never considered the 'null' constant a reference value. So this is how C# abstracts a "NullPointer" huh ? B/c as I recall in C++, a NPE can be caused by dereferencing an uninitialized pointer (ie, ref type in c#) whose default value happens to be an address that is not allocated to that process (many cases this would be 0, especially in later versions of C++ that did auto-initialization, which belongs to the OS - f with it and die beeotch (or just catch the sigkill the OS attacks your process with)).
– samsara
Jul 31 '13 at 18:55
Simon Mourier gave this example:
object o = null;
DateTime d = (DateTime)o; // NullReferenceException
where an unboxing conversion (cast) from object
(or from one of the classes System.ValueType
or System.Enum
, or from an interface type) to a value type (other than Nullable<>
) in itself gives the NullReferenceException
.
object
System.ValueType
System.Enum
Nullable<>
NullReferenceException
In the other direction, a boxing conversion from a Nullable<>
which has HasValue
equal to false
to a reference type, can give a null
reference which can then later lead to a NullReferenceException
. The classic example is:
Nullable<>
HasValue
false
null
NullReferenceException
DateTime? d = null;
var s = d.ToString(); // OK, no exception (no boxing), returns ""
var t = d.GetType(); // Bang! d is boxed, NullReferenceException
Sometimes the boxing happens in another way. For example with this non-generic extension method:
public static void MyExtension(this object x)
{
x.ToString();
}
the following code will be problematic:
DateTime? d = null;
d.MyExtension(); // Leads to boxing, NullReferenceException occurs inside the body of the called method, not here.
These cases arise because of the special rules the runtime uses when boxing Nullable<>
instances.
Nullable<>
While what causes a NullReferenceExceptions and approaches to avoid/fix such an exception have been addressed in other answers, what many programmers haven't learned yet is how to independently debug such exceptions during development.
In Visual Studio this is usually easy thanks to the Visual Studio Debugger.
First, make sure that the correct error is going to be caught - see
How do I allow breaking on 'System.NullReferenceException' in VS2010? Note1
Then either Start with Debugging (F5) or Attach [the VS Debugger] to Running Process. On occasion it may be useful to use Debugger.Break
, which will prompt to launch the debugger.
Debugger.Break
Now, when the NullReferenceException is thrown (or unhandled) the debugger will stop (remember the rule set above?) on the line on which the exception occurred. Sometimes the error will be easy to spot.
For instance,
in the following line the only code that can cause the exception is if myString
evaluates to null. This can be verified by looking at the Watch Window or running expressions in the Immediate Window.
myString
var x = myString.Trim();
In more advanced cases, such as the following, you'll need to use one of the techniques above (Watch or Immediate Windows) to inspect the expressions to determine if str1
was null or if str2
was null.
str1
str2
var x = str1.Trim() + str2.Trim();
Once where the exception is throw has been located, it's usually trivial to reason backwards to find out where the null value was [incorrectly] introduced --
Take the time required to understand the cause of the exception. Inspect for null expressions. Inspect the previous expressions which could have resulted in such null expressions. Add breakpoints and step through the program as appropriate. Use the debugger.
1 If Break on Throws is too aggressive and the debugger stops on an NPE in the .NET or 3rd-party library, Break on User-Unhandled can be used to limit the exceptions caught. Additionally, VS2012 introduces Just My Code which I recommend enabling as well.
If you are debugging with Just My Code enabled, the behavior is slightly different. With Just My Code enabled, the debugger ignores first-chance common language runtime (CLR) exceptions that are thrown outside of My Code and do not pass through My Code
Adding a case when the class name for entity used in entity framework is same as class name for a web form code-behind file.
Suppose you have a web form Contact.aspx whose codebehind class is Contact and you have an entity name Contact.
Then following code will throw a NullReferenceException when you call context.SaveChanges()
Contact contact = new Contact { Name = "Abhinav"};
var context = new DataContext();
context.Contacts.Add(contact);
context.SaveChanges(); // NullReferenceException at this line
For the sake of completeness DataContext class
public class DataContext : DbContext
{
public DbSet<Contact> Contacts {get; set;}
}
and Contact entity class. Sometimes entity classes are partial classes so that you can extend them in other files too.
public partial class Contact
{
public string Name {get; set;}
}
The error occurs when both the entity and codebehind class are in same namespace.
To fix this, rename the entity class or the codebehind class for Contact.aspx.
Reason
I am still not sure about the reason. But whenever any of the entity class will extend System.Web.UI.Page this error occurs.
For discussion have a look at NullReferenceException in DbContext.saveChanges()
Another general case where one might receive this exception involves mocking classes during unit testing. Regardless of the mocking framework being used, you must ensure that all appropriate levels of the class hierarchy are properly mocked. In particular, all properties of HttpContext
which are referenced by the code under test must be mocked.
HttpContext
See "NullReferenceException thrown when testing custom AuthorizationAttribute" for a somewhat verbose example.
I have a different perspective to answering this. This sort of answers "what else can I do to avoid it?"
When working across different layers, for example in an MVC application, a controller needs services to call business operations. In such scenarios Dependency Injection Container can be used to initialize the services to avoid the NullReferenceException. So that means you don't need to worry about checking for null and just call the services from the controller as though they will always to available (and initialized) as either a singleton or a prototype.
public class MyController
{
private ServiceA serviceA;
private ServiceB serviceB;
public MyController(ServiceA serviceA, ServiceB serviceB)
{
this.serviceA = serviceA;
this.serviceB = serviceB;
}
public void MyMethod()
{
// We don't need to check null because the dependency injection container
// injects it, provided you took care of bootstrapping it.
var someObject = serviceA.DoThis();
}
}
-1: this only handles a single scenario - that of uninitialized dependencies. This is a minority scenario for NullReferenceException. Most cases are simple misunderstanding of how objects work. Next most frequent are other situations where the developer assumed that the object would be initialized automatically.
– John Saunders
Mar 7 '14 at 0:06
All others have already been answered above.
– Mukus
Mar 7 '14 at 0:23
Dependency injection is not generally used in order to avoid NullReferenceException. I don't believe that you have found a general scenario here. In any case, if you edit your answer to be more in the style of stackoverflow.com/a/15232518/76337, then I will remove the downvote.
– John Saunders
Mar 7 '14 at 0:30
On the matter of "what should I do about it", there can be many answers.
A more "formal" way of preventing such error conditions while developing is applying design by contract in your code. This means you need to set class invariants, and/or even function/method preconditions and postconditions on your system, while developing.
In short, class invariants ensure that there will be some constraints in your class that will not get violated in normal use (and therefore, the class will not get in an inconsistent state). Preconditions mean that data given as input to a function/method must follow some constraints set and never violate them, and postconditions mean that a function/method output must follow the set constraints again without ever violating them.
Contract conditions should never be violated during execution of a bug-free program, therefore design by contract is checked in practice in debug mode, while being disabled in releases, to maximize the developed system performance.
This way, you can avoid NullReferenceException
cases that are results of violation of the constraints set. For example, if you use an object property X
in a class and later try to invoke one of its methods and X
has a null value, then this will lead to NullReferenceException
:
NullReferenceException
X
X
NullReferenceException
public X { get; set; }
public void InvokeX()
{
X.DoSomething(); // if X value is null, you will get a NullReferenceException
}
But if you set "property X must never have a null value" as method precondition, then you can prevent the scenario described before:
//Using code contracts:
[ContractInvariantMethod]
protected void ObjectInvariant ()
{
Contract.Invariant ( X != null );
//...
}
For this cause, Code Contracts project exists for .NET applications.
Alternatively, design by contract can be applied using assertions.
UPDATE: It is worth mentioning that the term was coined by Bertrand Meyer in connection with his design of the Eiffel programming language.
I thought to add this as no one mentioned this, and as far as it exists as an approach, my intention was to enrich the topic.
– Nick L.
Dec 26 '14 at 1:03
Thank you for enriching the topic. I have given my opinion of your addition. Now others can do the same.
– John Saunders
Dec 26 '14 at 1:05
I thought this was a worthwhile addition to the topic given that this is a highly viewed thread. I've heard of code contracts before and this was a good reminder to consider using them.
– VoteCoffee
Jan 8 '15 at 2:03
A NullReferenceException
is thrown when we are trying to access Properties of a null object or when a string value becomes empty and we are trying to access string methods.
NullReferenceException
For example:
When a string method of an empty string accessed:
string str = string.Empty;
str.ToLower(); // throw null reference exception
When a property of a null object accessed:
Public Class Person {
public string Name { get; set; }
}
Person objPerson;
objPerson.Name /// throw Null refernce Exception
This is incorrect.
String.Empty.ToLower()
will not throw a null reference exception. It represents an actual string, albeit an empty one (i.e. ""
). Since this has an object to call ToLower()
on, it would not make sense to throw a null reference exception there.– Kjartan
Jul 24 '15 at 6:00
String.Empty.ToLower()
""
ToLower()
TL;DR: Try using Html.Partial
instead of Renderpage
Html.Partial
Renderpage
I was getting Object reference not set to an instance of an object
when I tried to render a View within a View by sending it a Model, like this:
Object reference not set to an instance of an object
@{
MyEntity M = new MyEntity();
}
@RenderPage("_MyOtherView.cshtml", M); // error in _MyOtherView, the Model was Null
Debugging showed the model was Null inside MyOtherView. Until I changed it to:
@{
MyEntity M = new MyEntity();
}
@Html.Partial("_MyOtherView.cshtml", M);
And it worked.
Furthermore, the reason I didn't have Html.Partial
to begin with was because Visual Studio sometimes throws error-looking squiggly lines under Html.Partial
if it's inside a differently constructed foreach
loop, even though it's not really an error:
Html.Partial
Html.Partial
foreach
@inherits System.Web.Mvc.WebViewPage
@{
ViewBag.Title = "Entity Index";
List<MyEntity> MyEntities = new List<MyEntity>();
MyEntities.Add(new MyEntity());
MyEntities.Add(new MyEntity());
MyEntities.Add(new MyEntity());
}
<div>
@{
foreach(var M in MyEntities)
{
// Squiggly lines below. Hovering says: cannot convert method group 'partial' to non-delegate type Object, did you intend to envoke the Method?
@Html.Partial("MyOtherView.cshtml");
}
}
</div>
But I was able to run the application with no problems with this "error". I was able to get rid of the error by changing the structure of the foreach
loop to look like this:
foreach
@foreach(var M in MyEntities){
...
}
Although I have a feeling it was because Visual Studio was misreading the ampersands and brackets.
You wanted
Html.Partial
, not @Html.Partial
– John Saunders
Jul 24 '15 at 13:55
Html.Partial
@Html.Partial
Also, please show which line threw the exception, and why.
– John Saunders
Jul 24 '15 at 13:56
The error occurred in MyOtherView.cshtml, which I did not include here, because the Model was not being properly sent in (it was
Null
), so I knew the error was with how I was sending the Model in.– Travis Heeter
Jul 27 '15 at 11:44
Null
What can you do about it?
There is a lot of good answers here explaining what a null reference is and how to debug it. But there is very little on how to prevent the issue or at least make it easier to catch.
Check arguments
For example, methods can check the different arguments to see if they are null and throw an ArgumentNullException
, an exception obviously created for this exact purpose.
ArgumentNullException
The constructor for the ArgumentNullException
even takes the name of the parameter and a message as arguments so you can tell the developer exactly what the problem is.
ArgumentNullException
public void DoSomething(MyObject obj) {
if(obj == null)
{
throw new ArgumentNullException("obj", "Need a reference to obj.");
}
}
Use Tools
There are also several libraries that can help. "Resharper" for example can provide you with warnings while you are writing code, especially if you use their attribute: NotNullAttribute
There's "Microsoft Code Contracts" where you use syntax like Contract.Requires(obj != null)
which gives you runtime and compile checking: Introducing Code Contracts.
Contract.Requires(obj != null)
There's also "PostSharp" which will allow you to just use attributes like this:
public void DoSometing([NotNull] obj)
By doing that and making PostSharp part of your build process obj
will be checked for null at runtime. See: PostSharp null check
obj
Plain Code Solution
Or you can always code your own approach using plain old code. For example here is a struct that you can use to catch null references. It's modeled after the same concept as Nullable<T>
:
Nullable<T>
[System.Diagnostics.DebuggerNonUserCode]
public struct NotNull<T> where T: class
{
private T _value;
public T Value
{
get
{
if (_value == null)
{
throw new Exception("null value not allowed");
}
return _value;
}
set
{
if (value == null)
{
throw new Exception("null value not allowed.");
}
_value = value;
}
}
public static implicit operator T(NotNull<T> notNullValue)
{
return notNullValue.Value;
}
public static implicit operator NotNull<T>(T value)
{
return new NotNull<T> { Value = value };
}
}
You would use very similar to the same way you would use Nullable<T>
, except with the goal of accomplishing exactly the opposite - to not allow null
. Here are some examples:
Nullable<T>
null
NotNull<Person> person = null; // throws exception
NotNull<Person> person = new Person(); // OK
NotNull<Person> person = GetPerson(); // throws exception if GetPerson() returns null
NotNull<T>
is implicitly cast to and from T
so you can use it just about anywhere you need it. For example, you can pass a Person
object to a method that takes a NotNull<Person>
:
NotNull<T>
T
Person
NotNull<Person>
Person person = new Person { Name = "John" };
WriteName(person);
public static void WriteName(NotNull<Person> person)
{
Console.WriteLine(person.Value.Name);
}
As you can see above as with nullable you would access the underlying value through the Value
property. Alternatively, you can use an explicit or implicit cast, you can see an example with the return value below:
Value
Person person = GetPerson();
public static NotNull<Person> GetPerson()
{
return new Person { Name = "John" };
}
Or you can even use it when the method just returns T
(in this case Person
) by doing a cast. For example, the following code would just like the code above:
T
Person
Person person = (NotNull<Person>)GetPerson();
public static Person GetPerson()
{
return new Person { Name = "John" };
}
Combine with Extension
Combine NotNull<T>
with an extension method and you can cover even more situations. Here is an example of what the extension method can look like:
NotNull<T>
[System.Diagnostics.DebuggerNonUserCode]
public static class NotNullExtension
{
public static T NotNull<T>(this T @this) where T: class
{
if (@this == null)
{
throw new Exception("null value not allowed");
}
return @this;
}
}
And here is an example of how it could be used:
var person = GetPerson().NotNull();
GitHub
For your reference I made the code above available on GitHub, you can find it at:
https://github.com/luisperezphd/NotNull
Related Language Feature
C# 6.0 introduced the "null-conditional operator" that helps with this a little. With this feature, you can reference nested objects and if any one of them is null
the whole expression returns null
.
null
null
This reduces the number of null checks you have to do in some cases. The syntax is to put a question mark before each dot. Take the following code for example:
var address = country?.State?.County?.City;
Imagine that country
is an object of type Country
that has a property called State
and so on. If country
, State
, County
, or City
is null
then address will be
null. Therefore you only have to check whether
addressis
null`.
country
Country
State
country
State
County
City
null
address will be
. Therefore you only have to check whether
is
It's a great feature, but it gives you less information. It doesn't make it obvious which of the 4 is null.
Built-in like Nullable?
C# has a nice shorthand for Nullable<T>
, you can make something nullable by putting a question mark after the type like so int?
.
Nullable<T>
int?
It would be nice if C# had something like the NotNull<T>
struct above and had a similar shorthand, maybe the exclamation point (!) so that you could write something like: public void WriteName(Person! person)
.
NotNull<T>
public void WriteName(Person! person)
Never throw NullReferenceException
– John Saunders
Mar 6 '16 at 20:35
@JohnSaunders dare I ask why? (Seriously though why?)
– Luis Perez
Mar 7 '16 at 15:29
NullReferenceException is meant to be thrown by the CLR. It means that a reference to a null has occurred. It does not mean that a reference to a null would occur except that you cleverly checked first.
– John Saunders
Mar 7 '16 at 15:43
I see your point about how that would be confusing. I've updated it to a regular exception for this example and a custom exception in GitHub.
– Luis Perez
Mar 7 '16 at 18:41
Great answer for such a basic question. It's not so bad when it is your code that is failing. It's horrible when it's coming from deep inside some a commercial third party library you are relying on, and the customer support keeps insisting that it has to be your code that is causing the problem. And your not entirely sure it's not and the whole project is ground to halt.. I actually think this might make an appropriate epitaph for my tombstone: "Object reference not set to an instance of an object."
– Darrel Lee
May 3 '16 at 4:01
You can fix NullReferenceException in a clean way using Null-conditional Operators in c#6 and write less code to handle null checks.
It's used to test for null before performing a member access (?.) or index (?[) operation.
Example
var name = p?.Spouse?.FirstName;
is equivalent to:
if (p != null)
{
if (p.Spouse != null)
{
name = p.Spouse.FirstName;
}
}
The result is that the name will be null when p is null or when p.Spouse is null.
Otherwise, the variable name will be assigned the value of the p.Spouse.FirstName.
For More details : Null-conditional Operators
The error line "Object reference not set to an instance of an object.
" states that you have not assigned instance object to a object reference and still you are accessing properies/methods of that object.
for example: let say you have a class called myClass and it contains one property prop1.
public Class myClass
{
public int prop1 {get;set;}
}
Now you are accessing this prop1 in some other class just like below:
public class Demo
{
public void testMethod()
{
myClass ref = null;
ref.prop1 = 1; //This line throws error
}
}
above line throws error because reference of class myClass is declared but not instantiated or an instance of object is not assigned to referecne of that class.
To fix this you have to instantiate (assign object to reference of that class).
public class Demo
{
public void testMethod()
{
myClass ref = null;
ref = new myClass();
ref.prop1 = 1;
}
}
This answer has already been answered.
– John Saunders
Mar 8 '17 at 11:31
Interestingly, none of the answers on this page mention the two edge cases, hope no one minds if I add them:
Generic dictionaries in .NET are not thread-safe and they sometimes might throw a NullReference
or even (more frequent) a KeyNotFoundException
when you try to access a key from two concurrent threads. The exception is quite misleading in this case.
NullReference
KeyNotFoundException
If a NullReferenceException
is thrown by unsafe
code, you might look at your pointer variables, and check them for IntPtr.Zero
or something. Which is the same thing ("null pointer exception"), but in unsafe code, variables are often cast to value-types/arrays, etc., and you bang your head against the wall, wondering how a value-type can throw this exception.
NullReferenceException
unsafe
IntPtr.Zero
(Another reason for non-using unsafe code unless you need it, by the way)
Your dictionary example is not an edge case. If the object is not thread safe, then using it from multiple threads produces random results. Your unsafe code example differs from
null
in which way?– John Saunders
Mar 24 '17 at 2:03
null
NullReferenceException or Object reference not set to an instance of an object occurs when an object of the class you are trying to use is not instantiated.
For example:
Assume that you have a class named Student.
public class Student
{
private string FirstName;
private string LastName;
public string GetFullName()
{
return FirstName + LastName;
}
}
Now, consider another class where you are trying to retrieve the student's full name.
public class StudentInfo
{
public string GetStudentName()
{
Student s;
string fullname = s.GetFullName();
return fullname;
}
}
As seen in the above code, the statement
Student s - only declares the variable of type Student, note that the Student class is not instantiated at this point.
Hence, when the statement s.GetFullName() gets executed, it will throw the NullReferenceException.
Well, in simple terms:
You are trying to access an object that isn't created or currently not in memory.
So how to tackle this:
Debug and let the debugger break... It will directly take you to the variable that is broken... Now your task is to simply fix this.. Using the new keyword in the appropriate place.
If it is caused on some database commands because the object isn't present then all you need to do is do a null check and handle it:
if (i == null) {
// Handle this
}
The hardest one .. if the GC collected the object already... This generally occurs if you are trying to find an object using strings... That is, finding it by name of the object then it may happen that the GC might already cleaned it up... This is hard to find and will become quite a problem... A better way to tackle this is do null checks wherever necessary during the development process. This will save you a lot of time.
By finding by name I mean some framework allow you to FIndObjects using strings and the code might look like this: FindObject("ObjectName");
If you have a reference to an object, then the GC never cleans it up
– John Saunders
Dec 24 '15 at 7:51
if you use things like FindObject("Name of Object") there is no way GC will know before hand that you are going to refernece that object .. this is what is was trying to explaing .. these occur at runtime
– Akash Chowdary
Dec 24 '15 at 8:11
There are some frameworks that Provide this functionality in C# such as Unity . the question has nothing related to BCl. Search the Internet before Criticizing there are a ton of functions like them and for ur kind information i even use it daily. Now please tell me how does the answer doesn't make anysense.
– Akash Chowdary
Dec 24 '15 at 12:35
docs.unity3d.com/ScriptReference/… check the link and correct urself mr.expert :p
– Akash Chowdary
Dec 24 '15 at 12:54
The examples I saw in your link assign the results of GameObject.Find to a member field. That's a reference and the GC will not collect it until the containing object is collected.
– John Saunders
May 25 '16 at 18:00
If we consider common scenarios where this exception can be thrown, accessing properties withing object at the top.
Ex:
string postalcode=Customer.Address.PostalCode;
//if customer or address is null , this will through exeption
in here , if address is null , then you will get NullReferenceException.
So, as a practice we should always use null check, before accessing properties in such objects (specially in generic)
string postalcode=Customer?.Address?.PostalCode;
//if customer or address is null , this will return null, without through a exception
This has already been answered several times.
– John Saunders
Aug 26 '17 at 3:24
Reference types default to null to indicate that they are not referencing any object. Hence, if you try and access the object that is being referenced and there isn't one, you will get a NullReferenceException.
For Ex:
SqlConnection connection = null;
connection.Open();
When you run this code, you will get :
System.NullReferenceException: Object reference not set to an instance of an object.
You can avoid this error by coding like this:
if (connection != null){
connection.Open();
}
Note: In order to avoid this error you should always initialize your objects before you try to do anything with them.
If one is getting this message during saving or compiling the build, just close all the files and then open any file to compile and save.
For me the reason was that I had rename the file and old file was still open.
Literally the easiest way to fix a NullReferenceExeption has two ways.
If you have a GameObject for example with a script attached and a variable named rb (rigidbody) this variable will start null when you start your game.
This is why you get a NullReferenceExeption because the computer does not have data stored in that variable.
I'll be using a RigidBody variable as an example.
We can add data really easily actually in a few ways:
rb = GetComponent<Rigidbody>();
Start()
Awake()
rb = AddComponent<RigidBody>();
Further Notes: If you want unity to add a component to your object and you might have forgotten to add one, you can type [RequireComponent(typeof(RigidBody))]
above your class declaration (the space below all of your usings).
Enjoy and have fun making games!
[RequireComponent(typeof(RigidBody))]
It means you are trying to manipulate something which has reference but not yet initialized
The first thing to do here is check every instance created.
Use breakpoints , watches , inspect your varibale values.
Follow stack trace and search for exact row and column which is creating problem
To use methods and member of an object you first have to create that object. If you didn't create it (variable that should hold the object is not initialized), but you try to use it's methods or variables you'll get that error.
Sometime you may just forgot to do initialization.
Edited: new can't return null, but fire's exception when failed. Long time ago it was the case in some languages, but not any more. Thanks @John Saunders for pointing that out.
new
never returns null– John Saunders
Oct 27 '17 at 13:00
new
@John did you mean to accept this answer?
– CodeCaster
Oct 27 '17 at 14:48
@code no. Thanks for the catch. Phone app.
– John Saunders
Oct 27 '17 at 14:49
Thank you for your interest in this question.
Because it has attracted low-quality or spam answers that had to be removed, posting an answer now requires 10 reputation on this site (the association bonus does not count).
Would you like to answer one of these unanswered questions instead?
The exception helper in VS 2017 will be more helpful in diagnosing the cause of this exception -- blogs.msdn.microsoft.com/visualstudio/2016/11/28/… under New Exception Helper.
– Zev Spitz
Dec 29 '16 at 9:06