Ets_Log_Dbox_Open()
Note: Requires OPNET Development Kit
Abstract
Opens a log viewer with data from a specified log.
Syntax
Ets_Log_Dbox_Open (title, options, log_store_handle)
| Argument | Type | Description |
|---|---|---|
title |
const char * |
Title to display for the log viewer dialog box |
options |
int |
Flags to control which columns are displayed (see Details). |
log_store_handle |
PrgT_Log_Store_Handle |
handle to a log store as obtained from one of the opening APIs in the prg_log package |
Return Type
EtsT_Dbox *
The log viewer, or PRGC_NIL if the operation failed.
Header
ets_api_log.h
Details
This function opens a log viewer dialog box, as with the Open Simulation Log menu item in the Project Editor. The log data is made available via a log store (as described in Chapter 7 “Log Package” on page 53). The log viewer is described in “Log Viewer“ on page 23.
options should be ETSC_LOG_DBOX_OPT_NONE or an OR’ed combination of one or more of the following constants:
ETSC_LOG_DBOX_OPT_LATEST_FIRST—display the log entries from most recent to oldestETSC_LOG_DBOX_OPT_SHOW_COLORS—color the rows according to the values in the color key column