op_prg_log_handle_severity_get()
Abstract
Gets the severity type being used for log entries written to a given log handle.
Syntax
op_prg_log_handle_severity_get (handle, severity_ptr)
| Argument | Type | Description |
|---|---|---|
handle |
Log_Handle |
Log handle identifying the simulation log category of interest. |
severity_ptr |
“PrgT_Log_Severity_Type“ * |
Area to be filled with the current severity type used for entries written to the log handle; one of the symbolic values listed in Table 2 on page 80. |
Return Type
Compcode
OPC_COMPCODE_FAILURE if handle is invalid or severity_ptr is nil; OPC_COMPCODE_SUCCESS otherwise.
Example
PrgT_Log_Severity_Type severity;
Compcode status;
/* Configuration related notification handles. */
conf_log_handle = op_prg_log_handle_create (OpC_Log_Category_Configuration, "ATM", "Setup", atm_conf_log_limit);
status = op_prg_log_handle_severity_get (conf_log_handle, &severity);
if ((status != OPC_COMPCODE_FAILURE) && (severity != PrgC_Log_Severity_Warning))
op_prg_log_handle_severity_set (&conf_log_handle, PrgC_Log_Severity_Warning);
Details
None.
Purpose
Provides a way to get the severity being used for log entries written to a given log category.
Errors
- Recoverable Error: Invalid log handle.
Reference
- Use the KP op_prg_log_handle_severity_set() to set the severity type for future log entries written to a given log handle