prg_log_delete()
Abstract
Deletes the files that compose a log.
Syntax
prg_log_delete (log_name, log_directory)
| Argument | Type | Description |
|---|---|---|
log_name |
const char * |
Name of the log (no path or extension). |
log_directory |
const char * |
Full path of the directory containing the log, or an empty string (optional; see Details). |
Return Type
PrgT_Compcode
PrgC_Compcode_Success if the log is deleted successfully; PrgC_Compcode_Failure otherwise.
Header
prg_log.h
Details
A log consists of a directory (<log name>.olf.dir) containing a log_info file and all of the log’s data (*.ot) files. This function deletes the log directory and all files inside it.
If the log is a tfile, only the log_name argument is needed to locate and delete the log in the default tfile directory. If the log is not a tfile, you can use the log_directory argument to specify the directory containing the log (that is, the directory containing the <log name>.olf.dir directory).