HSDK Class Descriptions › CaTakeSnapshot

CaTakeSnapshot

CaTakeSnapshot encapsulates the TakeSnapshot process. It cannot be instantiated directly. The TakeSnapshot process can be set in the CaContext object either by name or object ID. The CaTakeSnapshot object can only be retrieved from the CaContext after it has been set. The administrator sets default attribute values.

Usage

• Set the Project, State, and TakeSnapshot Context.

  Three types of snapshots are possible. The first creates a snapshot view of the current contents of the view in selected state in the context. The second uses a passed in CaTimeStamp to take a snapshot of the contents matching that time. The third combines selected packages from Package Chooser and the name of a reference snapshotview to create a snapshot where the contents of the packages are overlayed on the view of the reference snapshot.

• Invoke the Execute function with the appropriate arguments for the desired behavior.

Public Methods

• SetCanViewExternallyFlag
• GetCanViewExternally
• Execute

More information:

• HSDK Programming Fundamentals
• CaContext
• CaTimeStamp
• CaPackageChooser