Oma_Ot_Table_Partial_Copy()
Abstract
Copies specific rows of an OT table.
Syntax
Oma_Ot_Table_Partial_Copy (ot_table_ptr, first_row, partial_row_count, stub_missing_rows)
| Argument | Type | Description |
|---|---|---|
ot_table_ptr |
OmaT_Ot_Table * |
OT table of interest. |
first_row |
int |
Index of the first row to be included in the copy. |
partial_row_count |
int |
Number of rows to copy. |
stub_missing_rows |
PrgT_Boolean |
Whether or not to include stubbed rows in the copy (see stub_missing_rows). |
Return Type
OmaT_Ot_Table *
Partial copy of the specified OT table, or PRGC_NIL if a copy could not be made.
Header
oma_ot.h
Details
This function creates and returns a private partial copy of the specified table. The source table can be a reader table or (if the writer file format supports random access (“write-many”)) a writer table. In either case, the returned table is, in effect, a reader table in that it is no longer tied to the file or the file’s data.
The caller should destroy the returned table with Oma_Ot_Table_Destroy() when it is no longer needed.
stub_missing_rows
When a table contains only a partial slice of the available data, the other rows are stubbed out so that the data slice is placed in context. If stub_missing_rows is PRGC_TRUE, such stubbed rows (if any) are included in the copy. If it is PRGC_FALSE, the first row (index = 0) of the returned table will have the data found in the first specified row (index = first_row) of the source table; also, the returned table will have exactly partial_row_count rows.