IArchivableObject.DisableArchiving Method

Disable historical archiving for this object.

[Visual Basic .NET]
Public Sub DisableArchiving ( _
    ByVal deleteArchive As Boolean, _
    ByVal traverseRelationships As Boolean _
)

[C#]
public void DisableArchiving (
    bool deleteArchive,
    bool traverseRelationships
);

[C++]
HRESULT DisableArchiving(
  VARIANT_BOOL deleteArchive,
  VARIANT_BOOL traverseRelationships
);

[C++]
Parameters
deleteArchive [in]

  deleteArchive is a parameter of type bool
traverseRelationships [in]

  traverseRelationships is a parameter of type bool

Product Availability

Errors Returned

FDO_E_SCHEMA_LOCK_CONFLICT: Lock request conflicts with an established lock.

Remarks

The deleteArchive is a boolean argument that should be used to specify if the archive tables will be deleted when archiving is disabled on the class. If the traverseRelationships argument is set to true the disable archiving call will traverse any relationships the object participates in, disabling archiving on other associated objects. Set this argument to false when it is desired for only this IArchivableObject to be disabled.

It is necessary to disable archiving on a class before that class can be unregistered as versioned.

See Also