Ets_Output_Value_Cache_Hot_Link_Column_Index_Get()
Abstract
Gets the column index in the output table for the column containing a hot-link object. Converts the registered column tag to an index.
Syntax
Ets_Output_Value_Cache_Hot_Link_Column_Index_Get (cache_ptr)
| Argument | Type | Description |
|---|---|---|
cache_ptr |
EtsT_Output_Value_Cache * |
Output cache containing the value of interest. |
Return Type
int
Column index in the output table for accessing the hot-link object; -1 if unsuccessful (not a valid column).
Header
ets_api_output.h
Details
The hot-link column is necessary to determine which object the table row corresponds to. Normally, the hot-link column is the column with the object name hot-linked to the object in the workspace.
The column index is cached automatically in the cache object by the framework based on the hot_link_col_name that is registered for this value.