mi::bridge::IBridge_snapshot_context Class Reference
[Bridge server]
Description
Context to import or remove snapshots.
See also:
mi::bridge::IBridge_server::create_snapshot_context()
Public Member Functions
- virtual neuraylib::IImport_result* import_snapshot( neuraylib::ITransaction* transaction, const char* snapshot_id, const IMap* importer_options = 0) =0
- Imports a previously saved snapshot from the disk cache. More...
- virtual Sint32 remove_snapshot( const char* snapshot_id) =0
- Removes a previously save snapshot from the disk cache. More...
Member Functions
- virtual neuraylib::IImport_result* mi::bridge::IBridge_snapshot_context::import_snapshot( neuraylib::ITransaction* transaction, const char* snapshot_id, const IMap* importer_options = 0) [pure virtual]
-
Imports a previously saved snapshot from the disk cache. In the case of incremental snapshots the base snapshot must be loaded first, and then each incremental snapshot in sequence.
Parameters
- transaction
- The transaction into which to import the elements.
- snapshot_id
- The ID of the snapshot to import.
- importer_options
- Optional importer options.
Returns
Result of the import operation with the following error codes:
- 0: Success.
- 4001: Invalid parameters.
- 4002: Failed to open the disk cache.
- 4003: There is no snapshot with the given ID in this disk cache.
- 4004: Snapshot has an incompatible Bridge version.
- 4005: Failed to import the snapshot elements.
- >= 4006: Unspecified error.
- virtual Sint32 mi::bridge::IBridge_snapshot_context::remove_snapshot( const char* snapshot_id) [pure virtual]
-
Removes a previously save snapshot from the disk cache.
Parameters
- snapshot_id
- The ID of the snapshot to remove.
Returns
- 0: Success.
- -1: Invalid parameters.
- -2: Failed to open the disk cache.
- -3: There is no snapshot with the given ID in this disk cache.
- <= -4: Unspecified error