Windows Driver Kit: Kernel-Mode Driver Architecture
ObReferenceObject

The ObReferenceObject routine increments the reference count to the given object.

VOID
  ObReferenceObject(
    IN PVOID  Object
    );

Parameter

Object
Pointer to the object. The caller obtained this parameter either when it created the object or from a preceding call to ObReferenceObjectByHandle after it opened the object.

Return Value

ObReferenceObject returns a value that is reserved for system use. Drivers must treat this value as VOID.

Comments

ObReferenceObject simply increments the pointer reference count for an object, without making any access checks on the given object, as ObReferenceObjectByHandle and ObReferenceObjectByPointer do.

ObReferenceObject prevents deletion of the object at least until the driver subsequently calls its reciprocal, ObDereferenceObject, or closes the given object. The caller must decrement the reference count with ObDereferenceObject as soon as it is done with the object.

When the reference count for an object reaches zero, a kernel-mode component can remove the object from the system. However, a driver can remove only those objects that it created, and a driver should never attempt to remove any object that it did not create.

Requirements

IRQL: <=DISPATCH_LEVEL

Headers: Declared in Wdm.h. Include Wdm.h, Ntddk.h, or Ntifs.h.

See Also

ObReferenceObjectByHandle, ObReferenceObjectByPointer, ObDereferenceObject, ZwClose


Send feedback on this topic
Built on November 19, 2009
Page view tracker