Function tskit::bindings::tsk_table_collection_init [−][src]
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 one or more of the following bitwise flags:
TSK_NO_EDGE_METADATA Do not allocate space to store metadata in the edge table. Operations attempting to add non-empty metadata to the edge table will fail with error TSK_ERR_METADATA_DISABLED.
@endrst
@param self A pointer to an uninitialised tsk_table_collection_t object. @param options Allocation time options. Currently unused; should be set to zero to ensure compatibility with later versions of tskit. @return Return 0 on success or a negative value on failure.