Ets_Log_Dbox_Column_Options_Get()
Note: Requires OPNET Development Kit
Abstract
Gets the current options for a column of a log.
Syntax
Ets_Log_Dbox_Column_Options_Get (dbox_ptr, column_title)
| Argument | Type | Description |
|---|---|---|
dbox_ptr |
EtsT_Dbox * |
Log viewer of interest. |
column_title |
const char * |
Name of the column for which to get options. |
Return Type
int
Current options for the specified column (see Details).
Header
ets_api_log.h
Details
This function returns the current column options, which specify whether the column will be displayed in the log viewer, whether it will be filterable, and whether it is the color key for the log. You can change the column options with Ets_Log_Dbox_Column_Options_Set().
The returned options are either ETSC_LOG_DBOX_OPT_NONE or an OR’ed combination of the desired constants:
ETSC_LOG_COLUMN_OPT_HIDE—the column will not be displayedETSC_LOG_COLUMN_OPT_FILTER—the column will be included in the filter treeETSC_LOG_COLUMN_OPT_COLOR—the column is the color key