Oma_Ot_Table_Cell_Nth_Value_Get()
Abstract
Gets the indexed value for a specified cell in a table.
Syntax
Oma_Ot_Table_Cell_Nth_Value_Get (ot_table_ptr, row, column, value_index, value_reference)
| Argument | Type | Description |
|---|---|---|
ot_table_ptr |
OmaT_Ot_Table * |
OT table of interest. |
row |
int |
Index of the row containing the cell of interest. |
column |
int |
Index of the column containing the cell of interest. |
value_index |
int |
Index of the desired value within the cell. Index 0 corresponds to the first value in multi-value cells and to the only value in single-value cells. |
value_reference |
void * |
Memory to be filled with a reference to the requested value (must be int *, double *, or char **). |
Return Type
PrgT_Compcode
PrgC_Compcode_Failure if the specified value does not exist or has not been loaded into a partial table; PrgC_Compcode_Success otherwise.
Header
oma_ot.h
Details
The type of the value_reference argument is determined by the type specified in the template. If the type of the referenced value is char *, the string's memory is allocated by this function and should be freed using prg_mem_free().