image_to_file#

file.image_to_file(p0: str) int#

Specifies if the image should be saved to a disk file.

If flag is set to OFF, the other choice, printing the image directly to a printer should be specified. If ON the “file: image_file” command should be specified. The default is ON, i.e., this command does not have to be specified if printing an image to a file.
Args:
p0:

‘toggle’

  • ON

  • OFF

Examples:
ensight.file.image_format("jpeg")
ensight.file.image_to_file("ON")
ensight.file.image_file("/tmp/test_image")
ensight.file.save_image()
Returns:

zero on success, non-zero on error