Edit

ObjectIDGenerator Class

  • Reference

Definition

Namespace:
System.Runtime.Serialization
Assembly:
System.Runtime.Serialization.Formatters.dll
Assembly:
mscorlib.dll
Assembly:
netstandard.dll
Source:
ObjectIDGenerator.cs
Source:
ObjectIDGenerator.cs
Source:
ObjectIDGenerator.cs

Caution

Formatter-based serialization is obsolete and should not be used.

Generates IDs for objects.

public ref class ObjectIDGenerator
public class ObjectIDGenerator
[System.Obsolete("Formatter-based serialization is obsolete and should not be used.", DiagnosticId="SYSLIB0050", UrlFormat="https://aka.ms/dotnet-warnings/{0}")]
public class ObjectIDGenerator
[System.Serializable]
public class ObjectIDGenerator
[System.Serializable]
[System.Runtime.InteropServices.ComVisible(true)]
public class ObjectIDGenerator
type ObjectIDGenerator = class
[<System.Obsolete("Formatter-based serialization is obsolete and should not be used.", DiagnosticId="SYSLIB0050", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>]
type ObjectIDGenerator = class
[<System.Serializable>]
type ObjectIDGenerator = class
[<System.Serializable>]
[<System.Runtime.InteropServices.ComVisible(true)>]
type ObjectIDGenerator = class
Public Class ObjectIDGenerator
Inheritance
Object
ObjectIDGenerator
Attributes
ObsoleteAttribute SerializableAttribute ComVisibleAttribute

Remarks

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.

Constructors

ObjectIDGenerator()

Initializes a new instance of the ObjectIDGenerator class.

Methods

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetId(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.
GetType()

Gets the Type of the current instance.

(Inherited from Object)
HasId(Object, Boolean)

Determines whether an object has already been assigned an ID.
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also