Function tskit::bindings::tsk_table_collection_init
source · pub unsafe extern "C" fn tsk_table_collection_init(
self_: *mut tsk_table_collection_t,
options: tsk_flags_t
) -> c_int
Expand description
@brief Initialises the table collection by allocating the internal memory and initialising all the constituent tables.
@rst
This must be called before any operations are performed on the table
collection. See the :ref:sec_c_api_overview_structure
for details on how objects
are initialised and freed.
Options**
Options can be specified by providing bitwise flags:
- :c:macro:
TSK_TC_NO_EDGE_METADATA
@endrst
@param self A pointer to an uninitialised tsk_table_collection_t object. @param options Allocation time options as above. @return Return 0 on success or a negative value on failure.