Oma_Ot_Writer_Table_Add()
Abstract
Creates a table for an object, using a specified template.
Syntax
Oma_Ot_Writer_Table_Add (ot_writer_ptr, type, group_name, obj_path, category_and_table_name, template_ptr)
| Argument | Type | Description |
|---|---|---|
ot_writer_ptr |
OmaT_Ot_Writer * |
OT writer of interest. |
type |
OmaT_Ot_Table_Type |
Table type, specified by one of the symbolic constants in Table 175. |
group_name |
const char * |
Group to which this table belongs. PRGC_NIL if not required. |
obj_path |
const char * |
Hierarchical path of the object to which this table belongs. PRGC_NIL for global tables. |
category_and_table_name |
const char * |
Key descriptors for the table, in the form “<category>.<table_name>” (for example, “ATM.Interface Configuration”). |
template_ptr |
OmaT_Ot_Template * |
Template to be used for the new table. |
Return Type
OmaT_Ot_Table *
The new table. PRGC_NIL if the writer is undefined, category_and_table_name is not specified, or a table cannot be allocated.
Header
oma_ot.h
Details
The returned table is owned by the writer and will be destroyed when the writer is closed. Explicitly destroying the table with Oma_Ot_Table_Destroy() before the writer is closed will safely free the data structure, but the table will still be included in the output file.