Class ObjectStreamClass

Namespace
ESRI.ArcGIS.esriSystem
Assembly
ESRI.Server.System.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("043731D0-A7CF-11D1-8BD1-080009EE4E41")]
public class ObjectStreamClass : ObjectStream, IObjectStream, IStream, ISequentialStream, IDocumentVersion
Inheritance
ObjectStreamClass
Implements
Inherited Members

Constructors

ObjectStreamClass()

public ObjectStreamClass()

Explicit Interface Implementations

Clone(out IStream)

virtual void Clone(out IStream ppstm)

Parameters

ppstm IStream

Commit(uint)

virtual void Commit(uint grfCommitFlags)

Parameters

grfCommitFlags uint

DocumentVersion

The version of the document to save.

virtual esriArcGISVersion DocumentVersion { get; set; }

Returns

esriArcGISVersion

Remarks

Determines which version an object is persisted.  This can be useful when saving an object ObjectStream or MemoryBlobStream and you want the version of that object to be compatible with previous releases of ArcGIS.  Not all persistable objects implement IDocumentVersion; you should ensure the object supports this interface before accessing this property.

LoadObject(ref Guid, object)

Load an object from the specified stream. The first time an object is encountered, it is loaded from the stream. When subsequent references to the object are loaded, a pointer to the first object is returned.

virtual object LoadObject(ref Guid riid, object pUnkOuter)

Parameters

riid Guid
pUnkOuter object

Returns

object

Remarks

The first parameter of LoadObject is a GUID of an interface ID (most of them could be find under HKEY_CLASSES_ROOT\Interface in the registry), not the object's GUID. The object that gets loaded will QI for this interface and the result is returned with the IUnknown parameter.

LockRegion(_ULARGE_INTEGER, _ULARGE_INTEGER, uint)

virtual void LockRegion(_ULARGE_INTEGER libOffset, _ULARGE_INTEGER cb, uint dwLockType)

Parameters

libOffset _ULARGE_INTEGER
cb _ULARGE_INTEGER
dwLockType uint

RemoteCopyTo(IStream, _ULARGE_INTEGER, out _ULARGE_INTEGER, out _ULARGE_INTEGER)

virtual void RemoteCopyTo(IStream pstm, _ULARGE_INTEGER cb, out _ULARGE_INTEGER pcbRead, out _ULARGE_INTEGER pcbWritten)

Parameters

pstm IStream
cb _ULARGE_INTEGER
pcbRead _ULARGE_INTEGER
pcbWritten _ULARGE_INTEGER

RemoteRead(out byte, uint, out uint)

virtual void RemoteRead(out byte pv, uint cb, out uint pcbRead)

Parameters

pv byte
cb uint
pcbRead uint

RemoteSeek(_LARGE_INTEGER, uint, out _ULARGE_INTEGER)

virtual void RemoteSeek(_LARGE_INTEGER dlibMove, uint dwOrigin, out _ULARGE_INTEGER plibNewPosition)

Parameters

dlibMove _LARGE_INTEGER
dwOrigin uint
plibNewPosition _ULARGE_INTEGER

RemoteWrite(ref byte, uint, out uint)

virtual void RemoteWrite(ref byte pv, uint cb, out uint pcbWritten)

Parameters

pv byte
cb uint
pcbWritten uint

ReplaceObject(object)

Replaces the current object with the object in the the specified stream.

virtual void ReplaceObject(object unknown)

Parameters

unknown object

Revert()

virtual void Revert()

SaveObject(object)

Store an object to the specified stream. The first time the object is stored, the full object is written to the stream. When the object is subsequently stored, a reference is stored.

virtual void SaveObject(object pUnk)

Parameters

pUnk object

SetSize(_ULARGE_INTEGER)

virtual void SetSize(_ULARGE_INTEGER libNewSize)

Parameters

libNewSize _ULARGE_INTEGER

Stat(out tagSTATSTG, uint)

virtual void Stat(out tagSTATSTG pstatstg, uint grfStatFlag)

Parameters

pstatstg tagSTATSTG
grfStatFlag uint

Stream

The aggregated stream object.

virtual IStream Stream { get; set; }

Returns

IStream

UnlockRegion(_ULARGE_INTEGER, _ULARGE_INTEGER, uint)

virtual void UnlockRegion(_ULARGE_INTEGER libOffset, _ULARGE_INTEGER cb, uint dwLockType)

Parameters

libOffset _ULARGE_INTEGER
cb _ULARGE_INTEGER
dwLockType uint

Version

The software version for the stream.

virtual string Version { get; set; }

Returns

string