IntPtr, SafeHandle and HandleRef - Explained
IntPtr
is just a simple integer-based struct that can hold a pointer (ie., 32 bit size on 32-bit systems, 64-bit size on 64-bit systems).
SafeHandle
is a class that is intended to hold Win32 object handles - it has a finalizer that makes sure that the handle is closed when the object is GC'ed. SafeHandle
is an abstract class because different Win32 handles have different ways they need to be closed. Prior to the introduction of SafeHandle
, IntPtr
was used to hold Win32 handles, but ensuring that they were properly closed and prevented from being GC'ed was the responsibility of the programmer.
HandleRef
is a way to make sure that an unmanaged handle is not GC'ed when you're in the middle of a P/Invoke call. Without something like HandleRef
, if your managed code doesn't do anything with the handle after the P/Invoke call, if the GC were run during the P/Invoke call it would not realize that the handle was still in use and might GC it. I imagine (but I'm not sure and haven't looked) that SafeHandle
might use HandleRef
as part of its management of the encapsulated handle.
HWnd a = new HWnd();
B.SendMessage(a.Handle, ...);
Assuming this is the only reference to "a" in the program, this is equivalent to:
HWnd a = new HWnd();
IntPtr h = a.Handle;
// a is no longer needed and thus can be GC'ed
B.SendMessage(h, ...);
The problem is that when "a" is disposed, it will close the handle. If this happens before or during the call to SendMessage, the handle will be invalid.
HandleRef prevents "a" from being garbage collected before the program is done with h.