SecureBlackbox 2020 Python Edition

Questions / Feedback?

on_progress Event

Reports the progress of data compression.

Syntax

class ArchiveWriterProgressEventParams(object):
  @property
  def processed() -> int: ...
  @property
  def total() -> int: ...
  @property
  def overall_processed() -> int: ...
  @property
  def overall_total() -> int: ...
  @property
  def cancel() -> bool: ...
  @cancel.setter
  def cancel(value) -> None: ...

# In class ArchiveWriter:
@property
def on_progress() -> Callable[[ArchiveWriterProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[ArchiveWriterProgressEventParams], None]) -> None: ...

Remarks

Subscribe to this event to be notified about compression progress.

Processed and Total report the progress of compression of the current entry; OverallProcessed and OverallTotal report the progress of the whole operation. Set Cancel to true to stop the operation.

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2020 Python Edition - Version 20.0 [Build 8154]