log.add
| Syntax |
log.add (item, logname, flTextFile, flOutline, flGuestDB, flWpText, flViewLog)
|
| Params |
item is either a string or a list containing the entry to be added to the log. logname is a string containing the name of the log to add an entry to. flTextFile (optional) is a boolean: if true then the log item is written to a text file. If not supplied, the value at user.log.prefs.flLogToTextFile is used. flOutline (optional) is a boolean: if true, then the log item is written to an outline. If not supplied, the value at user.log.prefs.flLogToOutline is used. flGuestDB (optional) is a boolean: if true, then the log item is written to a daily log guest database. If not supplied, the value at user.log.prefs.flLogToGuestDatabase is used. flWpText (optional) is a boolean: if true, and the log is being written to a guest database, then the log entry will be stored as a wp-text item. flViewLog (optional) is a boolean: if true, then the log should be opened for viewing after it's written to. If not supplied, the value at user.log.prefs.flViewLog is used.
|
| Action |
Adds an item to a specific log, based on the parameters and the user's preferences.
|
| Returns |
True.
|
| Examples |
log.add ("one", "docServerTestLog") » true
|
| Notes |
The new optional parameters were added in Frontier 6. The options for logging to text files, outlines, and guest databases are not mutually exclusive: one may choose all, some, or none of the options. In Frontier 6, logging to a guest database is encouraged over outline and text file logging. In general, it's best when calling log.add not to supply any of the optional parameters other than flWpText. This way the user's preferences are respected. However, sometimes there's a good reason for doing over-riding those preferences, which is why those parameters exist.
|
| See Also |
log.addToGuestDatabase
|
