ObjectIDGenerator Class
Collapse the table of content
Expand the table of content

ObjectIDGenerator Class


Generates IDs for objects.

Namespace:   System.Runtime.Serialization
Assembly:  mscorlib (in mscorlib.dll)


public class ObjectIDGenerator


Initializes a new instance of the ObjectIDGenerator class.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetId(Object, Boolean)

Returns the ID for the specified object, generating a new ID if the specified object has not already been identified by the ObjectIDGenerator.


Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodHasId(Object, Boolean)

Determines whether an object has already been assigned an ID.


Creates a shallow copy of the current Object.(Inherited from Object.)


Returns a string that represents the current object.(Inherited from Object.)

The ObjectIDGenerator keeps track of previously identified objects. When you ask for the ID of an object, the ObjectIDGenerator knows whether to return the existing ID, or generate and remember a new ID.

The IDs are unique for the life of the ObjectIDGenerator instance. Generally, a ObjectIDGenerator life lasts as long as the Formatter that created it. Object IDs have meaning only within a given serialized stream, and are used for tracking which objects have references to others within the serialized object graph.

Using a hash table, the ObjectIDGenerator retains which ID is assigned to which object. The object references, which uniquely identify each object, are addresses in the runtime garbage-collected heap. Object reference values can change during serialization, but the table is updated automatically so the information is correct.

Object IDs are 64-bit numbers. Allocation starts from one, so zero is never a valid object ID. A formatter can choose a zero value to represent an object reference whose value is null.

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
© 2015 Microsoft