[This is preliminary documentation and is subject to change.]
Deserialises a tree from am open stream.
Declaration Syntax
C# |
public static Persistent Deserialise( Stream stream )
Parameters
- stream (Stream)
- An open readable stream containing serialised data. If te stream contains more than one message, only the first is used.
Return Value
The root object of the deserialised tree. Can be null.
Remarks
The stream must be from a data source which has been created
using the TreeSerialiser class. The object tree will be
created exactly as it was when serialised, including associated
collections. The object cache is not used when deserialising, and the
resulting tree of objects is detached from the persistent tree. It can be
attached to the tree by setting the returned root object into a contained
scalar member or collection.