JobLogger class | QSYS API Reference Guide
Defines the core behavior of a job message logger and provides a base for derived classes.
Namespace: ASNA.QSys.Runtime.JobSupport Assembly: ASNA.QSys.Runtime.dll
Inheritance: Object
Properties
| Type | Name | Description |
|---|---|---|
| MessageLoggingLevel | LogLevel | Gets the logger’s level setting. |
| Int32 | MinPriority | Gets the minimum priority needed on a message for it to get logged. |
Methods
| Signature | Description |
|---|---|
| Add(MessageBase) | Adds a message to the log. |
| BeginLogging() | When overridden in a derived class, logging of messages gets started for the log. |
| EndLogging() | When overridden in a derived class, logging of messages is stopped. |
| Get() | Gets the logger. |
| ShouldLog(MessageBase) | Determines if a message should be added to the log. |
void Add(MessageBase entry)
Adds a message to the log.
void Add(MessageBase entry)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| MessageBase | entry | The message to be logged. |
void BeginLogging()
When overridden in a derived class, logging of messages gets started for the log.
void BeginLogging()
void EndLogging()
When overridden in a derived class, logging of messages is stopped.
void EndLogging()
IJobLogger Get()
Gets the logger.
IJobLogger Get()
bool ShouldLog(MessageBase msg)
Determines if a message should be added to the log.
bool ShouldLog(MessageBase msg)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| MessageBase | msg | Message in question. |
Returns
| Type | Description |
|---|---|
| Boolean | true if the message should be logged; otherwise false. |