Ets_Log_Key_Color_Get()
Note: Requires OPNET Development Kit
Abstract
Gets the color used for rows with a specified key.
Syntax
Ets_Log_Key_Color_Get (dbox_ptr, key)
| Argument | Type | Description |
|---|---|---|
dbox_ptr |
EtsT_Dbox * |
Log viewer of interest. |
key |
const char * |
Unique key for which to get the assigned color. The key must be one of the values in the list returned by Ets_Log_Color_Keys_List_Get(). |
Return Type
EtsT_Color
The color assigned to the specified key.
Header
ets_api_log.h
Details
The rows of a log can be displayed using different colors. The colors used are based on the values found in a specific column called the color key column. Each unique value in the color key column is a key. This function returns the color assigned to the specified key.