Function tskit::bindings::tsk_site_table_init [−][src]
pub unsafe extern "C" fn tsk_site_table_init(
self_: *mut tsk_site_table_t,
options: tsk_flags_t
) -> c_int
Expand description
@brief Initialises the table by allocating the internal memory.
@rst
This must be called before any operations are performed on the table.
See the :ref:sec_c_api_overview_structure
for details on how objects
are initialised and freed.
@endrst
@param self A pointer to an uninitialised tsk_site_table_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.