Ets_Log_Color_Keys_List_Get()
Note: Requires OPNET Development Kit
Abstract
Gets a list of unique values for a specified column of a log.
Syntax
Ets_Log_Color_Keys_List_Get (dbox_ptr, color_key_column_title, value_lptr)
| Argument | Type | Description |
|---|---|---|
dbox_ptr |
EtsT_Dbox * |
Log viewer of interest. |
color_key_column_title |
char * |
Area to hold the name of the column that is set as the color key, or PRGC_NIL. |
value_lptr |
PrgT_List * |
Text list to be filled with unique values from the color key column. |
Return Type
EtsT_Compcode
EtsC_Compcode_Success if the color key value list is obtained; EtsC_Compcode_Failure otherwise.
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. This function returns a text list of each unique value in the currently specified color key column. The returned list can be used with Ets_Log_Key_Color_Get() and Ets_Log_Key_Color_Set() to manage the row colors.