System Global Function CATSysErrorLog
| CATSysErrorLog( | const | iDefectClassOrSoftware, |
| | iSeverity, |
| | iParameteredNLSMessage, |
| | iNonNLSErrorMsg) |
-
Output a message to a dedicated log.
Role: Allows to log various messages in a dedicated location.
This error logging may be activated via Tools/Option.
If the logging output is active, any message declared with CATSysErrorLog will appear in the corresponding log.
Otherwise, no message will appear.
- Parameters:
-
- iDefectClassOrSoftware
- Defines the class of the logged message.
This parameter allows to create families of defects.
Its value may be the name of a framework or any meaningful error class.
Examples:
- Geometric Error
- Visualization Error
- Update Error
- I/O Error
- iSeverity
- Defines the severity level of the logged message.
Legal values:
- CATSysErrorLogSeverityError
- CATSysErrorLogSeverityWarning
- CATSysErrorLogSeverityComment
- iParameteredNLSMessage
- The logged message to be built with an NLS message catalog.
This NLS message may have parameters.
Characters ":" and ";" are forbidden. Carriage returns are not recommended.
This allows the administrator to get messages in native language.
- iNonNLSErrorMsg
- The logged message in English, built in the code itself.
Characters ":" and ";" are forbidden. Carriage returns are not recommended.
This allows to get messages understandable by most developpers (useful for debugging purpose).
- See also:
-
This object is included in the file: CATSysErrorLog.h
Copyright © 1999-2015, Dassault Systèmes. All rights reserved.