Interface IDocumentVersionSupportGEN

Namespace
ESRI.ArcGIS.esriSystem
Assembly
ESRI.Server.System.dll

Provides access to extend the IObjectStream interface with methods to hande saving objects that did not exist in previous versions of the software.

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("BB75DA81-8DFE-4122-A9C2-86F07C539AD5")]
public interface IDocumentVersionSupportGEN

Remarks

When the object is about to be saved to the stream, a check is made to see if the object implements this interface.  If it does, a check will be made to ensure that the object is supported for a particular ArcGIS version.

Methods

ConvertToSupportedObject(esriArcGISVersion)

Convert the object to another object that is supported.

object ConvertToSupportedObject(esriArcGISVersion docVersion)

Parameters

docVersion esriArcGISVersion

Returns

object

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE.  Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version.  Not all objects will return a supported object; in these cases a null pointer will be returned.

IsSupportedAtVersion(esriArcGISVersion)

Is this object valid at the given document version.

bool IsSupportedAtVersion(esriArcGISVersion docVersion)

Parameters

docVersion esriArcGISVersion

Returns

bool

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream.  This result is based on the esriArcGISVersion enumeration.  In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.