neuray API Programmer's Manual

mi::bridge::IIray_bridge_snapshot_callback Class Reference

[Bridge client]

Description

Abstract interface for snapshot events.

See also:

mi::bridge::IIray_bridge_snapshot_context::create_snapshot()

mi::base::Interface_declare\< ..., mi::neuraylib::IProgress_callback \>Mixin class template for deriving new interface declarations. Abstract interface to report progress of a long-running operation back to the caller...Abstract interface to report progress of a long-running operation back to the caller. mi::base::Interface_declare\< ... \>Mixin class template for deriving new interface declarations. The basic extensible interface.The basic extensible interface.

Public Member Functions

virtual void ready( Sint32 error_code, const char* file_name) =0
Called when the snapshot is done or if there was an error. More...

Member Functions

virtual void mi::​bridge::​IIray_bridge_snapshot_callback::ready( Sint32 error_code, const char* file_name) [pure virtual]

Called when the snapshot is done or if there was an error.

Parameters

error_code
0 in case of success, or < 0 in case of failure.
  • 0: The snapshot was successfully created.
  • -1: Network error.
  • -2: Failed to execute server side job to save snapshot.
  • -3: The snapshot was canceled.
  • -4: Illegal characters in path.
  • -5: Failed to save .cb file.
  • -6: Failed to create snapshot.
  • -7: Server application refused the snapshot.
  • <= -8: Unspecified error.
file_name
The file name that was used for this snapshot if error_code was 0. Otherwise this is a short error message that describes the error.