This documentation is archived and is not being maintained.

Formatter.Schedule Method

Schedules an object for later serialization.

The Formatter type is not CLS-compliant. For more information about CLS compliance, see What is the Common Language Specification.

[Visual Basic]
Protected Overridable Function Schedule( _
   ByVal obj As Object _
) As Long
[C#]
protected virtual long Schedule(
 object obj
);
[C++]
protected: virtual __int64 Schedule(
 Object* obj
);
[JScript]
protected function Schedule(
   obj : Object
) : long;

Parameters

obj
The object to schedule for serialization.

Return Value

The object ID assigned to the object.

Remarks

Schedule obtains an ID for the object and puts it on the queue for later serialization if this is a new object ID. The schedule is a work queue of objects to serialize, and is held inside the formatter. If the object is already on the work queue, it will not be added a second time, but an exception will not be thrown either.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

Formatter Class | Formatter Members | System.Runtime.Serialization Namespace | ObjectIDGenerator

Show: