Function tskit::bindings::tsk_table_collection_clear
source · pub unsafe extern "C" fn tsk_table_collection_clear(
self_: *mut tsk_table_collection_t,
options: tsk_flags_t
) -> c_int
Expand description
@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-sequence level 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.
Options**
Options can be specified by providing one or more of the following bitwise flags:
- :c:macro:
TSK_CLEAR_PROVENANCE
- :c:macro:
TSK_CLEAR_METADATA_SCHEMAS
- :c:macro:
TSK_CLEAR_TS_METADATA_AND_SCHEMA
@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.