CompareObjectToSnapshot Method

In This Topic

Compares an unsaved object to the version of the object contained in the specified snapshot.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<NotNullAttribute()>
Public Function CompareObjectToSnapshot( _
   ByVal objectToCompare As ADTIndependentObject, _
   ByVal snapshotID As Guid, _
   ByRef messages As MessageCollection _
) As ReadOnlyCollection(Of ObjectComparison)

[NotNull()]
public ReadOnlyCollection<ObjectComparison> CompareObjectToSnapshot( 
   ADTIndependentObject objectToCompare,
   Guid snapshotID,
   out MessageCollection messages
)

[NotNull()]
public:
ReadOnlyCollection<ObjectComparison^>^ CompareObjectToSnapshot( 
   ADTIndependentObject^ objectToCompare,
   Guid snapshotID,
   [Out] MessageCollection^ messages
)

Parameters

objectToCompare: The object to generate the report for.
snapshotID: The RecordID of the ObjectChangeLog record that represents the snapshot.
messages: Returns any error messages reported by the comparison.

Return Value

A collection containing a single ArcanaDevelopment.adTempus.Shared.ObjectComparison object with the results of the comparison.

Remarks

This method compares based on the in-memory version of the target object passed to the method. Use CompareObjectCurrentVersionToSnapshot to compare the current saved version of an object to a snapshot version.

Reference

Scheduler Class
Scheduler Members