CreateDataSnapshot Method

In This Topic

Creates a snapshot of the current state of all or selected objects.

Syntax

Visual Basic
C#

'Declaration
 
Public Function CreateDataSnapshot( _
   ByVal objectsToSnapshot As List(Of OID), _
   ByVal label As String, _
   ByVal comments As String, _
   ByRef messages As MessageCollection _
) As Boolean

public bool CreateDataSnapshot( 
   List<OID> objectsToSnapshot,
   string label,
   string comments,
   out MessageCollection messages
)

Parameters

objectsToSnapshot: List of the OIDs of the objects to snapshot. Specify null or an empty list to create a full-system snapshot.
label: The label to apply to the snapshot.
comments: Any additional comments to save with the snapshot.
messages: Returns messages if the operation failed.

Return Value

True if the snapshot succeeds, or False if it fails.

Remarks

The caller must be an adTempus Administrator to perform a full-system snapshot.

Reference

Scheduler Class
Scheduler Members