int log_clean( LogDest ld );
Description
- Reset only the specified destination class and stream (encoded as a LogDest value). This is only
applicable to filesystem or XMEM destinations since they are locally persistent storage.
XMEM is automatically cleaned at start-up time, since it is not assumed to be non-volatile.
- If this operation is not applicable, 0 is returned with no further action.
|
NOTE
|
Please see the comments at the top of log.lib for a description of the message
logging subsystem.
|
Parameter
- ld
- Destination class and stream. Use one of the constants
LOG_DEST_FS2
or LOG_DEST_XMEM, then OR in the stream number (0-63).
Return Value
- 0: success
-2: The stream is out-of-range for the class.
Library
- log.lib
