Ets_Log_Dbox_Column_Options_Set()
Note: Requires OPNET Development Kit
Abstract
Sets the options for a column of a log.
Syntax
Ets_Log_Dbox_Column_Options_Set (dbox_ptr, column_title, options)
| Argument | Type | Description |
|---|---|---|
dbox_ptr |
EtsT_Dbox * |
Log viewer of interest. |
column_title |
const char * |
Name of the column for which to set options. |
options |
int |
Options to set (see Details). |
Return Type
EtsT_Compcode
EtsC_Compcode_Success if the options were set; EtsC_Compcode_Failure otherwise.
Header
ets_api_log.h
Details
This function specifies whether a column should be displayed in the log viewer, whether it should be filterable, and whether it is the color key for the log. You can determine the current column options with Ets_Log_Dbox_Column_Options_Get().
The options argument is either ETSC_LOG_DBOX_OPT_NONE or an OR’ed combination of the desired constants:
ETSC_LOG_COLUMN_OPT_HIDE—do not display this columnETSC_LOG_COLUMN_OPT_FILTER—include this column in the filter treeETSC_LOG_COLUMN_OPT_COLOR—make this column the color key
The options set by this function overwrite all previous options for the column.
Note: Only one column can be the color key. When you set a column as the color key, the options for the previous color key column are automatically changed.