Function tskit::bindings::tsk_table_collection_clear [−][src]
pub unsafe extern "C" fn tsk_table_collection_clear(
self_: *mut tsk_table_collection_t,
options: tsk_flags_t
) -> c_int
@brief Clears data tables (and optionally provenances and metadata) in this table collection.
@rst By default this operation clears all tables except the provenance table, retaining table metadata schemas and the tree-sequnce level metadata and schema.
Options**
Options can be specified by providing one or more of the following bitwise flags:
TSK_CLEAR_PROVENANCE Additionally clear the provenance table TSK_CLEAR_METADATA_SCHEMAS Additionally clear the table metadata schemas TSK_CLEAR_TS_METADATA_AND_SCHEMA Additionally clear the tree-sequence metadata and schema
No memory is freed as a result of this operation; please use
:c:func:tsk_table_collection_free to free internal resources.
@endrst
@param self A pointer to a tsk_table_collection_t object. @param options Bitwise clearing options @return Return 0 on success or a negative value on failure.