Function tskit::bindings::tsk_treeseq_copy_tables
source · pub unsafe extern "C" fn tsk_treeseq_copy_tables(
self_: *const tsk_treeseq_t,
tables: *mut tsk_table_collection_t,
options: tsk_flags_t
) -> c_int
Expand description
@brief Copies the state of the table collection underlying this tree sequence into the specified destination table collection.
@rst
By default the method initialises the specified destination table collection. If the
destination is already initialised, the :c:macro:TSK_NO_INIT
option should
be supplied to avoid leaking memory.
@endrst
@param self A pointer to a tsk_treeseq_t object. @param tables A pointer to a tsk_table_collection_t object. If the TSK_NO_INIT option is specified, this must be an initialised table collection. If not, it must be an uninitialised table collection. @param options Bitwise option flags. @return Return 0 on success or a negative value on failure.