DocumentImage.toFile Method

Module: DocumentImage

Definition

Saves the image to the specified file.

The compression level meaning depends on the algorithm used:

  • For JPEG compression, the value is the expected quality and may vary from 1 to 100.

  • For JPEG2000 compression, the value is the compression rate and may vary from 1 to 512.

  • For PNG compression, the value is the compression rate and may vary from 1 to 10.

  • For all other formats, the value is ignored.

to_file(self, filepath: str, compression_level: float) -> None

Parameters

filepath str
in A string that contains the name of the file to which to save the image.

compression_level float
in The compression level to be applied.

Exceptions

DocumentException
An error has occurred during Document Library execution.
void toFile(String? filepath, double compressionLevel)

Parameters

filepath String
in A string that contains the name of the file to which to save the image.

compressionLevel double
in The compression level to be applied.

Exceptions

DocumentException
An error has occurred during Document Library execution.
public void ToFile(string filepath, float compressionLevel)

Parameters

filepath string
in A string that contains the name of the file to which to save the image.

compressionLevel float
in The compression level to be applied.

Exceptions

DocumentException
An error has occurred during Document Library execution.
public void toFile(String filepath, float compressionLevel) throws DocumentException

Parameters

filepath String
in A string that contains the name of the file to which to save the image.

compressionLevel float
in The compression level to be applied.

Exceptions

DocumentException
An error has occurred during Document Library execution.
public func toFile(filepath: String, compressionLevel: Float) throws

Parameters

filepath String
in A string that contains the name of the file to which to save the image.

compressionLevel Float
in The compression level to be applied.

Exceptions

DocumentException
An error has occurred during Document Library execution.
int id3DocumentImage_ToFile (
    ID3_DOCUMENT_IMAGE hDocumentImage,
    const char * filepath,
    float compressionLevel)

Parameters

hDocumentImage ID3_DOCUMENT_IMAGE
in Handle to the DocumentImage object.

filepath const char *
in A string that contains the name of the file to which to save the image.

compressionLevel float
in The compression level to be applied.

Returns

int
An error code.
See id3DocumentError file for the list of possible error codes.