getProgress float Extractor::get_progress(void) const; Description: Returns the fraction of the Multifile extracted so far. |
requestAllSubfiles int Extractor::request_all_subfiles(void); Description: Requests all subfiles in the Multifile to be extracted. Returns the number requested. |
requestSubfile bool Extractor::request_subfile(Filename const &subfile_name); Description: Requests a particular subfile to be extracted when step() or run() is called. Returns true if the subfile exists, false otherwise. |
reset void Extractor::reset(void); Description: Interrupts the Extractor in the middle of its business and makes it ready to accept a new list of subfiles to extract. |
run bool Extractor::run(void); Description: A convenience function to extract the Multifile all at once, when you don't care about doing it in the background. First, call request_file() or request_all_files() to specify the files you would like to extract, then call run() to do the extraction. Also see step() for when you would like the extraction to happen as a background task. |
setExtractDir void Extractor::set_extract_dir(Filename const &extract_dir); Description: Specifies the directory into which all extracted subfiles will be written. Relative paths of subfiles within the Multifile will be written as relative paths to this directory. |
setMultifile bool Extractor::set_multifile(Filename const &multifile_name); Description: Specifies the filename of the Multifile that the Extractor will read. Returns true on success, false if the mulifile name is invalid. |
step int Extractor::step(void); Description: After all of the requests have been made via request_file() or request_all_subfiles(), call step() repeatedly until it stops returning EU_ok. step() extracts the next small unit of data from the Multifile. Returns EU_ok if progress is continuing, EU_error_abort if there is a problem, or EU_success when the last piece has been extracted. Also see run(). |